CLI Generated Commands - nesciens/xmms2-wiki GitHub Wiki
All commands in CLI follow the same structure and needs to be documented in several places:
- In the code, to provide help when the user type
help
command
orcommand
--help
. - In the man page.
- Other places that we didn't think about already.
Right now, command descriptions (including available options) need be dupplicated and kept in sync by hand. A very fastidious work!
This page describes a solution based on an xml-file to be processed to generate setup code and documentation. Another target would also be generated commandline validation to reduce the amount of validation code to write in functions actually running the command.