This merge, which is a WIP, attempts to improve the inline documentation of the sac2c sources. Other than the obvious reasons for wanting to do this, is that our current documentation generator Doxygen provides a lot of nifty facilitates that can help in making the code more accessible and understandable - like our AST XHTML page, one can quickly look through and understand how functions/structs/macros are used.
This is certainly ambitious, but some attempt needs to be made to at the least to bring about the following:
-
a clear documentation standard -
integration within the build system to generate the documentation -
some tool/hook to verify that commits adhere to the documentation standard before committing
Further goals (though likely not achievable in a reasonable amount of time) are:
-
improve/update existing documentation