{"id":22392929,"url":"https://github.com/nuald/adx","last_synced_at":"2025-03-26T22:21:28.426Z","repository":{"id":57549176,"uuid":"130161491","full_name":"nuald/adx","owner":"nuald","description":"Produces the code's auto-generated documentation in HTML, PDF or XML.","archived":false,"fork":false,"pushed_at":"2023-11-01T23:23:17.000Z","size":461,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-01T04:14:35.562Z","etag":null,"topics":["doxygen","html","jsdoc","xml"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nuald.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-19T05:02:44.000Z","updated_at":"2023-11-01T23:23:21.000Z","dependencies_parsed_at":"2024-06-20T14:06:36.271Z","dependency_job_id":"d85faf8b-0902-45d7-bbf0-a6680d8388ff","html_url":"https://github.com/nuald/adx","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuald%2Fadx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuald%2Fadx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuald%2Fadx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuald%2Fadx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nuald","download_url":"https://codeload.github.com/nuald/adx/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245743432,"owners_count":20665095,"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":["doxygen","html","jsdoc","xml"],"created_at":"2024-12-05T04:22:12.791Z","updated_at":"2025-03-26T22:21:28.385Z","avatar_url":"https://github.com/nuald.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# adx\nProduces the code's auto-generated documentation in HTML, PDF or XML.\n\n## Requirements\n\nThe tool utilizes Doxygen and JsDoc3 command line utilities, please be sure\nto install those first, e.g. for macOS:\n\n    $ brew install doxygen node\n    $ npm i jsdoc -g\n\nPlease note the tool uses `xsltproc` utility, so be sure that it's available\nin PATH.\n\n## Installation\n\n    go get -u github.com/nuald/adx\n\n## Usage\n\nPlease use the tool's flags to generate the corresponding output:\n\n```\nUsage: adx [-conf=(yaml-file)] -lang=(lang) [-jsconf=(jsdoc-conf)] [-src=(src-dir)]+ [-xml=(xml-file)]+ -title=(title) -out=(out.[html|pdf|xml])\nProduces the code's auto-generated documentation in HTML, PDF or XML.\n\nFlags:\n  -conf string\n    \tthe configuration file for the custom languages\n  -jsconf string\n    \tthe JSDoc configuration file\n  -lang string\n    \tthe source code programming language (js, java)\n  -out string\n    \tthe output file (the format is based on its extension)\n  -src value\n    \tthe source code dir(s)\n  -title string\n    \tthe document title\n  -xml value\n    \tthe input XML file(s)\n```\n\n## Development Notes\n\n`make` is utilized to perform various tasks related to development.\n\nUnit-testing:\n\n    $ make tests\n\nLocal installation:\n\n    $ make install\n\n## Custom Languages Support\n\nCustom languages are parsed based on the configuration files. The code should be documented\nin a special way as it's parsed to generate the documentation based on the rules\nfrom the configuration.\n\nCode sample:\n\n```\n/**\n * Class: Foo\n * Foo demo class\n *\n * @property prop The sample property.\n * @constructor Build an Foo class instance.\n */\nclass Foo(private val prop: String) {\n\n    /**\n     * Method: method1\n     * The sample method.\n     *\n     * @param arg The sample argument.\n     * @return The sample return.\n     */\n    fun method1(arg: String): Int {\n    }\n}\n```\n\n*Class:*, *Method:* (*Static Method:*, *Constructor:*) and *Property:* (*Static Property:*) markers\nare used to determine the block context. Classes may have the optional\n*@constructor* tag to identify that the constructor is implicitly defined\nwith the *@property* list as its arguments.\n\nThe configuration file has the following YAML format (see fixtures/config.yaml as an example):\n\n```\n\u003clanguage_name\u003e:\n  extensions: [list of extensions]\n  docstrings:\n    type: [block|line]\n    format: /** */\n    parameter: '@param (?P\u003cname\u003e\\w+)\\s?(?P\u003cdescription\u003e.*)'\n    return: '@return\\s?(?P\u003cdescription\u003e.*)'\n```\n\nPlease note that `parameter` and `return` are regular expressions that should have\nthe *name* (not for `return`) and *description* capture groups.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuald%2Fadx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnuald%2Fadx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuald%2Fadx/lists"}