js doc composer for interop with visual paradigm

This commit is contained in:
2024-11-27 09:05:37 +02:00
parent c2245d92b3
commit 54b8941f3c
9 changed files with 186 additions and 30 deletions
+7
View File
@@ -0,0 +1,7 @@
call jsdoc ../backend/app/App.js -t "./diagram-template/" -d "./out/App.h"
call jsdoc ../backend/app/Config.js -t "./diagram-template/" -d "./out/Config.h"
call jsdoc ../backend/app/Db.js -t "./diagram-template/" -d "./out/Db.h"
call jsdoc ../backend/app/bl/GamesManager.js -t "./diagram-template/" -d "./out/bl/GamesManager.h"
call jsdoc ../backend/app/bl/RulesManager.js -t "./diagram-template/" -d "./out/bl/RulesManager.h"
call jsdoc ../backend/app/bl/GameObjectsManager.js -t "./diagram-template/" -d "./out/bl/GameObjectsManager.h"
call jsdoc ../backend/app/bl/ScenariosManager.js -t "./diagram-template/" -d "./out/bl/ScenariosManager.h"
+3
View File
@@ -0,0 +1,3 @@
{
}
@@ -1,7 +1,13 @@
const fs = require('fs');
const typeMap = {
string: 'std::string',
Number: 'int'
}
function getType(t){
return (t?.type.names[0] || '').replace(/^Array\.\<(.*)\>$/, '$1*')
let tp = (t?.type?.names[0] || '').replace(/^Array\.\<(.*)\>$/, '$1*')
return typeMap[tp] || tp;
}
function graft(childNodes, parentLongname) {
@@ -9,12 +15,12 @@ function graft(childNodes, parentLongname) {
childNodes.filter(({memberof}) => memberof === parentLongname)
.forEach(element => {
if (element.kind === 'function') {
result += `${getType(element.returns?.[0]) || 'void'} ${element.name}(${ element.params?.map(p=>
result += `/* ${element.description} */ ${getType(element.returns?.[0]) || 'void'} ${element.name}(${ element.params?.map(p=>
`/* ${p.description || ''} */ ${getType(p)} ${p.name}`
).join(', ') || ''});\n`;
}
else if (element.kind === 'member') {
result += `/* ${element.description || ''} */ ${getType(element)} ${element.name};`
result += ` /* ${element.description || ''} */ ${getType(element)} ${element.name};\n`
}
else if (element.kind === 'class') {
@@ -36,20 +42,9 @@ exports.publish = (data, {destination, query}) => {
data({undocumented: true}).remove();
docs = data().get(); // <-- an array of Doclet objects
fs.promises.writeFile('./result.json', JSON.stringify(docs), {encoding:'utf-8'})
fs.promises.writeFile(destination+'.json', JSON.stringify(docs, null, 2), {encoding:'utf-8'})
let result = graft(docs);
console.log(result)
if (destination === 'console') {
if (query && query.format === 'xml') {
//console.log( xml.parse('xs:schema', root) );
}
else {
//console.log( require('jsdoc/util/dumper').dump(root) );
}
}
else {
console.log('This template only supports output to the console. Use the option "-d console" when you run JSDoc.');
}
let result = `#include <string>\n\n` + graft(docs);
//console.log(result)
fs.promises.writeFile(destination, result, {encoding:'utf-8'});
};