PHPDoc: How to document different class property options

Question

Is there any way with phpdoc to document the different values that a class property can take and what effect this will have. For example:-

class SomeClass {

   /**
   * Cell text align
   * 
   * null - table default
   * l - left align
   * r - right align
   * c - centre align
   * j - justify
   */
   public $align;

   Some code
}

Is there any way to make the value-description pairs be parsed by phpdoc so that it will turn them into a definition list or such like?

Unrelated: how do you intend to ensure that the variable contains these values? Have you thought about a protected variable with public getters and setters? — cmbuckley
– cmbuckley, Commented Mar 29, 2012 at 19:39

cmbuckley · Accepted Answer · 2012-03-29 19:41:14Z

2

Something like this will become a <ul> in the documentation output:

class SomeClass {

   /**
    * Cell text align
    * 
    * Possible values: 
    * - null - table default
    * - l - left align
    * - r - right align
    * - c - centre align
    * - j - justify
    */
   public $align;

   // Some code
}

From the manual page on DocBlock description details.

edited Mar 29, 2012 at 19:41

answered Mar 29, 2012 at 19:35

cmbuckley

43.1k10 gold badges83 silver badges95 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Ben Over a year ago

Soon we'll be able to look forward to PHPDocumentor 2 @ www.phpdoc.org, though it's not finished just yet as of this post.

Collectives™ on Stack Overflow

PHPDoc: How to document different class property options

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related