[Bash-completion-devel] [bash-completion-Bugs][314715] Please use doxygen for API documentation

[bash-completion-bugs at alioth.debian.org]

bash-completion-Bugs item #314715, was opened at 06/06/2014 22:30 by Dams Nadé
You can respond by visiting: 
https://alioth.debian.org/tracker/?func=detail&atid=413095&aid=314715&group_id=100114

Status: Open
Priority: 3
Submitted By: Dams Nadé (anvil-guest)
Assigned to: Nobody (None)
Summary: Please use doxygen for API documentation 
Distribution: None
Originally reported in: None
Milestone: None
Status: None
Original bug number: 


Initial Comment:
I would like to suggest using doxygen for the bash-completion project.

I have documented my own bash library (bash-argsparse) with it and the result is pretty convincing to me.

The result is available at http://argsparse.livna.org/doxygen/

Also please check :
* the original library source code, with inline documentation at https://github.com/Anvil/bash-argsparse/blob/master/argsparse.sh
* the doxygen configuration file used in the process https://github.com/Anvil/bash-argsparse/blob/master/Doxyfile
* and at last the doxygen filter file which makes all this possible. https://github.com/Anvil/bash-argsparse/blob/master/doxygen-bash.sed

The filter is potentially a bit limted, but either the filter or the source code can be adapted without too much trouble, I think.

If you are ok with that, I would like to start providing some patches for bash_completion. Me documenting functions could hepl improve my understanding of the internal "magic" involved in the bash_completion and provide better contributions.

Feel free to ask me any question about this.

----------------------------------------------------------------------

You can respond by visiting: 
https://alioth.debian.org/tracker/?func=detail&atid=413095&aid=314715&group_id=100114