Overview
Getting Started
Architecture
How To
Executing Documentation Generation
In order to generate documentation, you need to call the
generateDocumentation function of the generation module.The function has the following syntax:
1
generation.generateDocumentation(
2
Object data, // the parsed JSON data response received from the serializer
3
Fn successCallback, // callback to be executed on successful generation
4
Fn errorCallback, // callback to be executed on generation error
5
);
Copied!
Following this syntax, the below can be used to execute documentation generation:
1
generation.generateDocumentation(
2
data,
3
function (targetArchiveFilePath, targetArchiveFileName, targetFolderPath, targetHtmlDocFolderPath, targetMdjFilePath) {
4
...your logic to run on success...
5
},
6
function (error) {
7
...your logic to run on error...
8
}
9
);
Copied!
Last modified 3yr ago
Copy link