Class: PHP_DocBlockGenerator_Align

Source Location: /PHP_DocBlockGenerator-1.0.2/DocBlockGenerator/Align.php

Class Overview

Alignment of DocBlocks tags in a PHP file

Author(s):

Michel Corne <mcorne at yahoo.com>

Version:

SVN: $Id: Align.php 16 2007-06-27 10:15:08Z mcorne $

Copyright:

2007 Michel Corne

Methods

alignTags

Inherited Variables

Inherited Methods

Class Details

[line 51]
Alignment of DocBlocks tags in a PHP file

Author: Michel Corne <mcorne@yahoo.com>
Version: SVN: $Id: Align.php 16 2007-06-27 10:15:08Z mcorne $
Copyright: 2007 Michel Corne
Link: http://pear.php.net/package/PHP_DocBlockGenerator
License: The BSD License

[ Top ]

Method Detail

alignTags [line 121]

string alignTags(
string
$block)

Aligns the tags within a DocBlock

Calculates the necessary padding/alignments, aligns the tag first line, then the additional lines. The text preceeding the first tag is left untouched.

Return: the aligned DocBlock
Access: public

Parameters:

string $block — the DocBlock

[ Top ]