{"id":29068953,"url":"https://github.com/aspectron/gendoc","last_synced_at":"2025-06-27T11:09:41.110Z","repository":{"id":28142246,"uuid":"31642170","full_name":"aspectron/gendoc","owner":"aspectron","description":null,"archived":false,"fork":false,"pushed_at":"2016-08-13T08:32:21.000Z","size":799,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2023-08-05T09:42:50.468Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aspectron.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-04T06:36:18.000Z","updated_at":"2023-08-05T09:42:50.469Z","dependencies_parsed_at":"2022-09-04T08:52:16.460Z","dependency_job_id":null,"html_url":"https://github.com/aspectron/gendoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"purl":"pkg:github/aspectron/gendoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aspectron%2Fgendoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aspectron%2Fgendoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aspectron%2Fgendoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aspectron%2Fgendoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aspectron","download_url":"https://codeload.github.com/aspectron/gendoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aspectron%2Fgendoc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262244913,"owners_count":23281029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-27T11:09:40.209Z","updated_at":"2025-06-27T11:09:41.058Z","avatar_url":"https://github.com/aspectron.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gendoc\n\nYet another documentation generator from source code comments in Markdown format.\n\nSource code documentation should be placed into `/ ** ** /`\ncomment block. Comment block should be opened and closed on a separate line.\n\nDocumentation text may be formatted in Markdown.\nSupported tags:\n\u003cpre\u003e\n  @module name [- Brief description]\n  Module description. A separate Markdown document would be created for each\n  module with name `module.md`.\n\n  @class name  [- Brief]\n  Long class description.\n\n  @function functionName(param1, [param2], [param3=default_value])  [- Brief]\n  @param param1 [- Parameter descripton]\n  @param [param2] {Type} [- Optional parameter description with type]\n  @param [param3=default_value]\n  @param args*  - Argument list args1 .. argN\n  @param [args]* - Optional argument list\n  @return {Type} - function return descripton\n\n  @property qulified.name {Type} [- Brief]\n  Property description. Name may be qualified in scope of module.\n\u003c/pre\u003e\n\nJavaDoc autobrief is working - if no inline brief with tag, the first sentence\nfrom long description would be used.\n\nFor @class and @function additionaly @emit tags may be supplied:\n\n\u003cpre\u003e\n  @event eventName(param1, ... paramN) - Describe event, similar to function\n  @param param1 {Type} - Parameter description\n  @param paramN\n\u003c/pre\u003e\n\nFor @function tag @emit tags describe which events are fired from that function\n\n\u003cpre\u003e\n  @emit eventNameX\n  @emit eventNameY\n\u003c/pre\u003e\n\n## gendoc(config)\n\n  * config `Object`\n  * Return: `Object` Generated documentation object\n\nGenerate documentation from source code in Markdown format.\n\nConfiguration object `config` should have follwing options:\n  * `input` - array of input directories with source code to scan\n  * `output` - result output directory name, would be created on necessary\n  * `[cleanup=false]` - cleanup output directory before start\n  * `[reporter=console.log]` - function to report work progress\n  * `[extension='.md']` - result documents extension\n  * `[result]` - write result in JSON format into the output directory, if supplied\n  * `[single]` - additionaly generate whole documentation as a single document in the specified filename\n  * `[index]` - additionaly generate index document in the specified filename\n  * `[htmlOutput]` - convert generated Markdown to HTML pages in specified output directory\n  * `[htmlExtension='.html']` - extension for output HTML files\n  * `[htmlTemplate='template.html']` - HTML template filename\n  * `[htmlStyle='style.css']` - HTML stylesheet filename\n  * `[htmlHighliteStyle='highlight.js/styles/default.css']` - HTML stylesheet from highlight.js\n\nInput directory may be a String or a RegEx object. For recurse directory scanning\nspecify `*` as a last but one path element. Examples:\n\n```\n    // all files in `dir1` subdirectory\n    var input1 = './dir1';\n\n    // files with .js extension in `dir2` subdirectory\n    var input2 = './dir2/\\\\.+[.]js$';\n\n    // files with .hpp or .cpp extension in `dir3` and all its subdirectories\n    var input3 = './dir3/* /\\\\.+[.][hc]pp$';\n\n    gendoc({ output: './doc/out', input: [input1, input2, input3] });\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faspectron%2Fgendoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faspectron%2Fgendoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faspectron%2Fgendoc/lists"}