Your documentation needs a main page, of course, let's put it on your main header file, or your main source code file, in our example will be Eina.h In order to add Doxygen-specific comments, basically you just need to add an extra comment character, I'm not going to explain in detail that because you are not stupid, so let's directly continue with the howto :) Main Page Will be nice if there's some rules with things like nobody can add a new function without write its doxygen documentation or nobody can modify a piece of code without add its related doxygen documentation if doesn't has it.
It is very hard and even impossible to not have the api documented to day with the code using Doxygen.įor a final point, let me say that this reading should be obliged for anybody that write code, it is very handy for everybody and for himself to have the api documented correctly.
#DOXYGEN MAINPAGE UPDATE#
Maybe the highest lack that EFL has is the documentation of the API and the big problem about this is that's not easy to maintain the API documentation up to date, also, it is very easy to modify a function and do not update their related documentation.Īll these problems are solved with Doxygen, because doxygen is mainly just comments in the source code that in a result, you can build all the documentation needed (html pages, manpages, pdf's, etc) up to date with the code. You are more than welcome to edit this document and to modify it, and to add features on this small howto Introduction This is an ugly fast howto for doxygen main usages, you should close this page and read the official documentation instead.Ī specific documentation of the commands that we are going to look are available at
0 kommentar(er)
