{"id":13602848,"url":"https://github.com/Anvil/bash-doxygen","last_synced_at":"2025-04-11T13:31:35.792Z","repository":{"id":19194504,"uuid":"22427721","full_name":"Anvil/bash-doxygen","owner":"Anvil","description":"A doxygen filter for bash scripts","archived":false,"fork":false,"pushed_at":"2019-02-25T08:56:34.000Z","size":21,"stargazers_count":90,"open_issues_count":9,"forks_count":24,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-08-02T18:43:19.750Z","etag":null,"topics":["bash","doxygen","doxygen-filter","sed"],"latest_commit_sha":null,"homepage":null,"language":"sed","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"wtfpl","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Anvil.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-30T12:59:32.000Z","updated_at":"2024-05-05T17:59:50.000Z","dependencies_parsed_at":"2022-09-25T04:51:46.667Z","dependency_job_id":null,"html_url":"https://github.com/Anvil/bash-doxygen","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/Anvil%2Fbash-doxygen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Anvil%2Fbash-doxygen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Anvil%2Fbash-doxygen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Anvil%2Fbash-doxygen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Anvil","download_url":"https://codeload.github.com/Anvil/bash-doxygen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223470282,"owners_count":17150526,"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":["bash","doxygen","doxygen-filter","sed"],"created_at":"2024-08-01T18:01:40.493Z","updated_at":"2024-11-07T06:30:27.836Z","avatar_url":"https://github.com/Anvil.png","language":"sed","funding_links":[],"categories":["bash"],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/Anvil/bash-doxygen.svg?branch=master)](https://travis-ci.org/Anvil/bash-doxygen)\n\nbash-doxygen\n============\n\nA basic doxygen filter (originally written in GNU sed) allowing you to\nadd inline-documentation to your bash shell scripts.\n\n### Supported shell syntaxes\n\n* All lines starting with a `## ` (without any leading blanks) are\n  passed to doxygen. You can use all the doxygen commands you want in\n  those lines. (see [doxygen\n  documentation](http://www.stack.nl/~dimitri/doxygen/manual/commands.html)).\n\n* Some top level declarations will be recognized if you use the\n  `declare` primitive:\n  * `declare -a` for arrays\n  * `declare -A` for associative arrays\n  * `declare -i` for integers\n  * Any other top-level `declare` statement will consider variable is a string.\n  * Those additional declaration attributes can be combined with -A/-a/-i/\u003cnone\u003e:\n    * `declare -l` will mark the variable as LowerCase\n    * `declare -u` will mark the variable as UpperCase\n    * `declare -x` will mark the variable as Exported\n    * `declare -r` will mark the variable as ReadOnly\n  * Additionally, declaring a variable with an `export` statement will\n    also be recognized and the variable will be marked as an Exported\n    String.\n\n* Functions declaration will be recognized if all these conditions are met:\n  1. a `## @fn` line is found above the function declaration,\n  2. the function is declared either with or without the non-posix\n  `function` keyword, but always with `()`.\n  3. the body-opening `{` char is on the same line as the\n  `funcname()` instruction.\n\nHow to use it\n-------------\n\n1. If you do not have a Doxygen configuration file (usually named\n   Doxyfile), you can generate one by simply running `doxygen -g`.\n2. Edit the Doxyfile to map shell files to C parser: `EXTENSION_MAPPING = sh=C`\n3. Set your shell script file names pattern as Doxygen inputs, like\n   e.g.: `FILE_PATTERNS = *.sh`\n4. Mention doxygen-bash.sed in either the `INTPUT_FILTER` or the\n   `FILTER_PATTERN` directive of your Doxyfile. If doxygen-bash.sed is\n   in your $PATH, then you can just invoke it as is, else use `sed -n\n   -f /path/to/doxygen-bash.sed --`.\n\n*CAREFUL*: If you are a BSD and or a Mac user, you will definitely want\nto use `gsed` instead of `sed` to make it work.\n\nKnown limitations\n-----------------\n\nYes.\n\nFAQ\n---\n\nQ. Does it actually work ?\nA. The [bash-argsparse](https://github.com/Anvil/bash-argsparse)\nproject uses this filter. Check\n[the result](http://argsparse.livna.org/doxygen/). Click on the\nlinks. See by yourself.\n\nQ. Is it rock-solid ?\nA. No.\n\nQ. Do you accept patches ?\nA. Definitely.\n\nQ. Why is the project named bash-doxygen while the filter is named\ndoxygen-bash ?\nA. Yeah, haha. Seriously.\n\nQ. Can I include the doxygen-bash.sed file in my own tarball ?\nA. See the [COPYING](COPYING) file.\n\nQ. Dude. sed ? Seriously ?\nA. Are you.. Jealous ?\n\nQ. ... ?\nA. Don't you dare !\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAnvil%2Fbash-doxygen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAnvil%2Fbash-doxygen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAnvil%2Fbash-doxygen/lists"}