devs/jabber.space
2
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

fix(c-apidoc-parser): add detailed description to the output

Browse Source
This commit is contained in:
Jabber Developer
2025-09-23 13:39:43 +02:00
parent 58cc08b084
commit 3a98252e0c
1 changed files with 1 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/scripts/parser/apidoc/c-apidoc-parser.ts
View File

@@ -284,6 +284,7 @@ export class CApiDocParser {
private writeFile(docFile: DocFile) { private writeFile(docFile: DocFile) {
let stream = ""; let stream = "";
stream += this.writeFrontMatter(docFile.name, docFile.briefDescription || `${docFile.name} File Reference`); stream += this.writeFrontMatter(docFile.name, docFile.briefDescription || `${docFile.name} File Reference`);
stream += `${docFile.detailedDescription}\n\n`;
if (docFile.typedefs.length > 0) { if (docFile.typedefs.length > 0) {
stream += "## Typedefs\n\n"; stream += "## Typedefs\n\n";
for (const typedef of docFile.typedefs) { for (const typedef of docFile.typedefs) {
@@ -355,7 +356,6 @@ export class CApiDocParser {
} }
if (func.detailedDescription) { if (func.detailedDescription) {
if (func.detailedDescription.description) { if (func.detailedDescription.description) {
// stream += "#### 📄 Description";
stream += "\n\n" + func.detailedDescription.description + "\n\n"; stream += "\n\n" + func.detailedDescription.description + "\n\n";
} }
if (func.detailedDescription.params.length > 0) { if (func.detailedDescription.params.length > 0) {
@@ -382,7 +382,6 @@ export class CApiDocParser {
stream += "```c\n" + typedef.definition + "\n```\n"; stream += "```c\n" + typedef.definition + "\n```\n";
} }
if (typedef.detailedDescription) { if (typedef.detailedDescription) {
// stream += "#### 📄 Description";
stream += "\n\n" + typedef.detailedDescription + "\n\n"; stream += "\n\n" + typedef.detailedDescription + "\n\n";
} }
return stream; return stream;