ethonion10/v86
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Remove unused doc generation scripts

Browse source
This commit is contained in:
Fabian 2018-10-01 21:02:35 -03:00
commit e149b9d372
2 changed files with 0 additions and 123 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/build.js
View file

@ -1,16 +0,0 @@
#!/usr/bin/env node
var markdox = require("markdox");
var options = {
output: __dirname + "/api.md",
template: __dirname + "/template.md.ejs"
};
var files = [
__dirname + "/../src/browser/starter.js",
];
markdox.process(files, options, function() {
console.log("Ok. %s written.", options.output);
});

107
docs/template.md.ejs
View file

@ -1,107 +0,0 @@
<?
function anchorify(str)
{
// how github creates the name attribute for anchors from headlines
str = str.replace(/[()<>.]/g, "");
str = str.replace(/[^a-z0-9_-]+/gi, "-");
str = str.toLowerCase();
return str;
}
docfiles.forEach(function(doc)
{
doc.javadoc.forEach(function(comment)
{
var tags = comment.raw.tags;
comment.tagsByType = comment.raw.tags.reduce(function(result, tag)
{
result[tag.type] = tag;
return result;
}, {});
comment.ignore = "ignore" in comment.tagsByType;
if(comment.name && !comment.ignore)
{
if(comment.isMethod || comment.isFunction)
{
var args = comment.paramTags.map(function(c)
{
return c.joinedTypes + " " + c.name;
}).join(", ");
var returnVal = "";
if(comment.returnTags[0])
{
returnVal = " -> " + comment.returnTags[0].joinedTypes;
}
comment.args = args;
comment.returnVal = returnVal;
comment.longName = comment.name + "(" + comment.args + ")" + comment.returnVal;
?><?= "- [`" + comment.longName + "`](#" + anchorify(comment.longName) + ")\n" ?><?
} else {
?># <?= comment.name + "\n" ?><?
}
}
});
doc.javadoc.forEach(function(comment)
{
if(!comment.ignore)
{
?><?= "\n***\n" ?><?
if(comment.name)
{
if(comment.isMethod || comment.isFunction)
{
?><?= "#### `" + comment.longName + "`\n" ?><?
}
else
{
?><?= "## `" + comment.name + "`\n" ?><?
}
}
if(comment.deprecated)
{
?><?= "\n\n**Deprecated - Might be removed in a later release.**\n\n" ?><?
}
?><?= comment.description + "\n" ?><?
if(comment.paramTags.length)
{
?><?= "**Parameters:**\n\n" ?><?
comment.paramTags.forEach(function(paramTag, i)
{
?><?= (i + 1) + ". **`" + paramTag.joinedTypes + "`** " + (paramTag.optional ? "(optional) " : "") + paramTag.name + " " + (paramTag.description ? "– " + paramTag.description : "") + "\n" ?><?
});
}
if(comment.returnTags.length)
{
?><?= "**Returns:**\n\n" ?><?
comment.returnTags.forEach(function(returnTag)
{
?><?= "* **`" + returnTag.joinedTypes + "`** " + returnTag.description + "\n" ?><?
});
}
}
});
?><?= "\n<!-- " + doc.filename + "-->\n" ?><?
});
?>
<!-- vim: set tabstop=2 shiftwidth=2 softtabstop=2: -->