It should include documentation of all the source files (location, what functions does it implement, ...) and documentation about the functions itself (parameters, return values, what does the function).
OK, there's Doxygen, but it's missing the real documentation. In fact it cuts away the existing documentation.
And C-code is not always self-explanatory
I think it would make development for ROS easier and might attract other developers, if it contains undocumented windows functions.
It could be done like wine does it from inside the source code. And this could be updated regularly by a script.
Example of Wine documentation:
Code: Select all
/***********************************************************************
* InitCommonControlsEx [COMCTL32.@]
*
* Registers the common controls.
*
* PARAMS
* lpInitCtrls [I] pointer to an INITCOMMONCONTROLS structure.
*
* RETURNS
* Success: TRUE
* Failure: FALSE
*
* NOTES
* Only the additional common controls are registered by this function.
* The Win95 controls are registered at the DLL's initialization.
*
* FIXME
* implement the following control classes:
* ICC_LINK_CLASS
* ICC_STANDARD_CLASSES
*/
What do you think?