Supported Doc Comment Tags

Note: See the document "How to Write Doc Comments for the Javadoc Tool         
( http://java.sun.com/j2se/javadoc/writingdoccomments/index.html)
for a complete description of tags and comment style.

PHPDoc currently supports the following tags, listed in the
order in which they should appear in a Doc Comment. 
Note that some tags are not included in or deviate slightly from the 
JavaDoc standard (eg "access" and "param"). This is done to accomodate 
differences between PHP and Java language structure.

* Classes and Modules:

@author	- Use one tag per author, listed with first author first

@version	- Use the CVS keyword "$Revision: 1.1 $":
				@version $Revision: 1.1 $
				
@copyright - Use standard Sun Microsystems PRN


* Methods, Constructors, and Functions:

@access	- PHPDoc specific. Since PHP does not enforce 
			   public/private methods, this tag is used to indicate if 
			   the method/function is "private" or "public"			   

@param	- Use the convention of:
			@param type myParamName description
			eg: @param array $fooBar An array of foos.
			

@return	- Describes what the method or function returns.
			Use the format:
			@return type description

@throws | exception	- Since there aren't exceptions in PHP, this
					    	can refer to the error handling class

@see	- cross-reference to a class, interface, method, 
		constructor, field, or URL

@since	- specify the product version when this was added

@deprec | deprecated	- To indicate that class/method/function 
						has be deprecated.

{@link}	- See http://java.sun.com/products/jdk/1.2/docs/tooldocs/win32/javadoc.html#{@link}

@module		- Can be used to group related files together
@modulegroup	- Can be used to group related files together

@todo			- Show a todo list


* Other tags which may or may not do something useful:
@brother
@sister
@include
@exclude
@magic



--------------------------------------------------------------
Author: Eric Braswell
$Id: PHPDoc_Tags.txt,v 1.1 2001/10/13 23:13:42 ebraswell Exp $