Generate documentations using Doxygen
alanjian85 opened this issue · 1 comments
alanjian85 commented
Enhancing the maintainability of the existing codebase involves offering clear descriptions of the APIs. Utilizing Doxygen, a widely-used documentation generator for various programming languages including C, proves to be an effective approach. The generated documentation should encompass succinct and informative descriptions of all public files, functions, structures, enums and macros within the current code.
alanjian85 commented
The documentations of Karg has been automatically generated and uploaded to GitHub Pages. However, it is a time-consuming labor to write documentations for every components and subsystems of the whole kernel. It therefore should be deferred future versions.