WVAnnotation

create a new instance of WVAnnotation


Declaration

 wvAnnotation = WVAnnotation(name,description,options)

Parameters

  • name name of the method, property, or variable
  • description short description of the method, property, or variable
  • detailedDescription (optional) a detailed description of the method, property, or variable

Returns

  • wvAnnotation a new instance of WVAnnotation

Discussion

Creates a new instance of WVAnnotation with a name, description and optional detailed description.

If a markdown file of the same name is in the same directory or child directory, it will be loaded as the detailed description upon initialization.