When editing NUT codebase with a real IDE like NetBeans, it would be convenient for context pop-ups to explain the methods used and their parameters, etc.
Doxygen allows javadoc-like commenting of C/C++ codebase, and is supported by IDEs https://netbeans.apache.org/kb/docs/cnd/navigating-editing.html#_adding_source_code_documentation as well as command-line tools to generate API documentation, spell-check it, etc. (probably NUT does not require this aspect at the moment, with MAN pages for public API maintained in text files... but having them generated from actual codebase and not forgotten when APIs are updated would be a nice feature too).
For reference, a ZProject-inspired integration example in 42ITy:
Much of the content to "publish" this way for NUT is already there in "legacy" C/C++ comments, so the first step would likely be to just make them visible to parser by using /** (with two asterisks) to start the comment blocks before methods, and possibly to similarly pre-comment useful variables defined one per line rather than as a lot of declarations in one line as happens now.
When editing NUT codebase with a real IDE like NetBeans, it would be convenient for context pop-ups to explain the methods used and their parameters, etc.
Doxygen allows javadoc-like commenting of C/C++ codebase, and is supported by IDEs https://netbeans.apache.org/kb/docs/cnd/navigating-editing.html#_adding_source_code_documentation as well as command-line tools to generate API documentation, spell-check it, etc. (probably NUT does not require this aspect at the moment, with MAN pages for public API maintained in text files... but having them generated from actual codebase and not forgotten when APIs are updated would be a nice feature too).
For reference, a ZProject-inspired integration example in 42ITy:
Much of the content to "publish" this way for NUT is already there in "legacy" C/C++ comments, so the first step would likely be to just make them visible to parser by using
/**(with two asterisks) to start the comment blocks before methods, and possibly to similarly pre-comment useful variables defined one per line rather than as a lot of declarations in one line as happens now.