PHPDoc -
   Home - Documentation - Doc Comments 

 About PHPDoc 
   Doc Comments 
 Known Bugs 

   Doc Comments

A Doc Comment is a special case of an multiline comment that stands in front of certain keywords.

Structure of a Doc Comment

* Short description - used in indexlists
* Multiple line detailed description.
* The handling of line breaks and HTML is up to the renderer.
* Order: short description - detailed description - doc tags.
* @param	string	Target directory for the generated HTML Files

... to be continued.

@copyright Ulf Wendel