Build the html page for a class
A classes files counter
Build the html for a complete class
| Name | Type | Description |
|---|---|---|
| classDoc | ClassDoc | The object with the class documentation |
The name of the class currently treated
A array with the methods or properties that must be currently added to the html
The path between the html file and theConfig.destDir ( something like '../../../', depending of the folders tree )
Build the html for a method or property
| Name | Type | Description |
|---|---|---|
| methodOrPropertyDoc | MethodOrPropertyDoc | The object with the extracted documentation for the method or property |
Build the html for a method or property header
| Name | Type | Description |
|---|---|---|
| methodOrPropertyDoc | MethodOrPropertyDoc | The object with the extracted documentation for the method or property |
Build the html for methods and properties
| Name | Type | Description |
|---|---|---|
| heading | String | The header to add in the #html property before the methods and properties |
Build a string with the parameters from a MethodOrPropertyDoc object and enclose the string in ( ). Parameters names are extracted from the code.
| Name | Type | Description |
|---|---|---|
| methodOrPropertyDoc | MethodOrPropertyDoc | The object with the extracted documentation for the method |
Build an html table with the parameters from a MethodOrPropertyDoc object and include this table in the #html property. Parameters names are extracted from the code and parameters types and descriptions are extracted from the comments
| Name | Type | Description |
|---|---|---|
| methodOrPropertyDoc | MethodOrPropertyDoc | The object with the extracted documentation for the method |