Store all the links created from the source document and get the links completed with the path for others classes
Get all the classes links. Each subAray contains the class name and the class link.
Get all the sources links. Each subAray contains the source file name and the path between theConfig.destDir and the source file, included file name
Get all the variables links. Each subAray contains the variable name and the variable link.
Get the html link to a class file
| Name | Type | Description |
|---|---|---|
| className | String | The name of the class for witch the link must be created |
| rootPath | String | The path between the file where the link will be inserted and theConfig.destDir ( something like '../../../', depending of the folders tree ) |
Add links to a description
| Name | Type | Description |
|---|---|---|
| desc | String | The description to complete with links |
| rootPath | String | The path between the file where the link will be inserted and theConfig.destDir ( something like '../../../', depending of the folders tree ) |
Get a link to a source file
| Name | Type | Description |
|---|---|---|
| doc | VariableDoc or MethodOrPropertyDoc or VariableDoc | The doc for witch the link to the source file must be created. |
Get the links to a type
| Name | Type | Description |
|---|---|---|
| type | String | The types for witch the link must be created. Can be multiple word |
| rootPath | String | The path between the file where the link will be inserted and theConfig.destDir ( something like '../../../', depending of the folders tree ) |
Verify that a given type is a known type ( = present in the
| Name | Type | Description |
|---|---|---|
| type | String | The type to verify |
Store a link to a class file
| Name | Type | Description |
|---|---|---|
| classDoc | ClassDoc | The doc with the class documentation |
Store a link to a source file
| Name | Type | Description |
|---|---|---|
| fileName | String | The file name |
| path | String | The path since theConfig.destDir, included file name |
Store a link to a variable in the variables.html file
| Name | Type | Description |
|---|---|---|
| variableDoc | VariableDoc | The doc with the variable documentation |
A cache for the classes links
A cache for the sources links
The links to the variables file and the variables in the file
A cache for the variables links
Get the link to a type
| Name | Type | Description |
|---|---|---|
| type | String | The type for witch the link must be created. Must be a single word |
| rootPath | String | The path between the file where the link will be inserted and theConfig.destDir ( something like '../../../', depending of the folders tree ) |