My favorites | Sign in
Project Home Downloads Wiki Issues Source
Search
for
ModifierReference  
Tag Modifier Reference
Updated Feb 4, 2010 by denis.riabtchik

Navigation>> Start Next - ComplexTypes Previous - Comment Tag Attributes


Modifiers

For certain tags it is possible to specify optional modifiers. The supported standard modifiers are:

  • public
  • private
  • abstract
  • static
  • protected
  • optional

For variables and properties it is possible to specify two additional modifiers:

  • read
  • write

When documenting parameters the only applicable modifier is

  • optional

jGrouseDoc does not enforce any special semantics regarding modifiers. The only special handling is applied to optional parameters - they would appear in square brackets in function's summary.


Navigation>> Start Next - ComplexTypes Previous - Comment Tag Attributes


Sign in to add a comment
Powered by Google Project Hosting