fix(c-apidoc-parser): add detailed description to the output
This commit is contained in:
@@ -284,6 +284,7 @@ export class CApiDocParser {
|
||||
private writeFile(docFile: DocFile) {
|
||||
let stream = "";
|
||||
stream += this.writeFrontMatter(docFile.name, docFile.briefDescription || `${docFile.name} File Reference`);
|
||||
stream += `${docFile.detailedDescription}\n\n`;
|
||||
if (docFile.typedefs.length > 0) {
|
||||
stream += "## Typedefs\n\n";
|
||||
for (const typedef of docFile.typedefs) {
|
||||
@@ -355,7 +356,6 @@ export class CApiDocParser {
|
||||
}
|
||||
if (func.detailedDescription) {
|
||||
if (func.detailedDescription.description) {
|
||||
// stream += "#### 📄 Description";
|
||||
stream += "\n\n" + func.detailedDescription.description + "\n\n";
|
||||
}
|
||||
if (func.detailedDescription.params.length > 0) {
|
||||
@@ -382,7 +382,6 @@ export class CApiDocParser {
|
||||
stream += "```c\n" + typedef.definition + "\n```\n";
|
||||
}
|
||||
if (typedef.detailedDescription) {
|
||||
// stream += "#### 📄 Description";
|
||||
stream += "\n\n" + typedef.detailedDescription + "\n\n";
|
||||
}
|
||||
return stream;
|
||||
|
||||
Reference in New Issue
Block a user