This is a file that will be transformed into 'Doxyfile', which will control how Doxygen generates the documentation. To any Autotools users, this should outline the next step, to write the 'Doxyfile.in' file. We see a mention to 'docs/Doxyfile' above. ![]() Now in configure.ac, we can check to see if we have Doxygen and if so, add some files to later be processed. For this example, I will just put this in configure.ac: We can put all of this logic in an m4 script or in-line in the configure.ac file. If Doxygen is not found, output a warning message. We can do this by searching for the Doxygen program using the Autoconf macro AC_CHECK_PROGS. The first step is to determine if the user has Doxygen installed. If doxygen is not installed, output a warning message during configuration and do not generate any documentation. The documentation should be generated when the user runs 'make' and should be installed when the user runs 'make install'. I want the documentation to be able to be viewed using the man utility. In my case, I wrote documentation for a library that I plan for other developers to use. ![]() The first step is to decide how the process will work. I intend to outline that solution based off his book. ![]() Luckily after reading the great book that I cannot recommend enough, A Practitioner's Guide to GNU Autoconf, Automake, and Libtool by John Calcote, I learned a great solution. However, after searching the Internet, I was unable to find a decent tutorial. For my thesis source code, I desired to have Doxygen documentation automatically generated by make.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |