Validate the doc objects
Validate the documentation
| Name | Type | Description |
|---|---|---|
| classesDocs | Array of ClassDoc | The classes Doc objects found in the documentation |
| variablesDocs | Array of VariableDoc | The variable Doc objects found in the documentation |
A map to store the classes names
Display an error or warning on the screen
| Name | Type | Description |
|---|---|---|
| rule | Object | The rule that have generated the error or warning |
| doc | VariableDoc or ClassDoc or MethodOrPropertyDoc | The Doc object for witch the error is generated |
Validate a ClassDoc object
| Name | Type | Description |
|---|---|---|
| classDoc | ClassDoc | The Doc object to validate |
Apply a rule on a Doc object
| Name | Type | Description |
|---|---|---|
| rule | Object | The rule that have tobe applied on the Doc Object |
| doc | VariableDoc or ClassDoc or MethodOrPropertyDoc | The Doc object to validate |
Validate a MethodOrPropertyDoc object
| Name | Type | Description |
|---|---|---|
| methodOrPropertyDoc | MethodOrPropertyDoc | The Doc object to validate |
Validate a VariableDoc object
| Name | Type | Description |
|---|---|---|
| variableDoc | VariableDoc | The Doc object to validate |