My favorites | Sign in
Project Home Downloads Wiki Issues Source
Search
for
TagReference  
Tags supported by jGrouseDoc
Featured
Updated Feb 4, 2010 by denis.riabtchik

Navigation>> Start Next - Customization Guide Previous - Advanced Configuration Options


jGrouseDoc Tags Reference

@... Define secondary properties of an @param
@author Specify the author(s) of a function/file/class/etc
@class Declare and document a class object
@constructor Specify a class constructor method
@description Specify description of a project
@deprecated Indicate that a function/file/class/etc is deprecated
@end End the current namespace scope
@extends Define the inheritance structure of a class or interface
@file Provide documentation for a source file
@function Document a function
@ifunction Comment for function interfaces, for example when documenting the signature of callback functions
@implements Declare that a class implements an interface
@inheritdesc Inherit the description of an '@extend'ed class/interface
@interface Declare and document an interface
@link Create an inline reference to another function/class/etc
@module Define and document code that may be loaded dynamically
@namespace Defines new namespace
@paramset Used to declare an alternate function's or constructor's parameter set
@param Parameter of a function or constructor
@project Project description and attributes
@property Defines a class/structure property
@requires Specifies that current module requires another one to be loaded and/or initialized first
@return Describe the return behavior of a function
@scope Starts a new namespace scope
@see Refer to another part of the documentation
@since Specify the version in which a class/file/function/etc was introduced
@struct Definition of structure
@throws Describe the exceptions thrown by a function
@timestamp Insert the timestamp when the documentation project was created
@var Defines either a global variable in a namespace or class/structure member
@version Shows current version of software


Navigation>> Start Next - Customization Guide Previous - Advanced Configuration Options


Sign in to add a comment
Powered by Google Project Hosting