![]() As you know, HTML isn’t the most convenient (or professional, for that matter) output stream for everyone. ![]() Most developers use Doxygen to produce HTML-based docs for public or private consumption. But, you can still do a first pass on nearly any C, C++, Java, Objective-C, IDL (CORBA or Microsoft), C#, or PHP project and get great results. Of course, the more prep you add, the better the outcome. He has shepherded the project for the past decade, producing one of the world’s most widely used documentation packagers.Īs you may have guessed, Doxygen can get started with little or no source-code preparation. How do you get your head around this thing when there’s no place to start? For this and many other scenarios, Doxygen should be part of your toolset.ĭoxygen is the brainchild of Dimitri van Heesch, who made it available under the GNU General Public License. Whether you are working in C or C#, the same old bugaboo rears its ugly head: How do you keep the documentation of function parameters accurate and consistent with the actual use cases? With Doxygen, you extract the documentation directly from the sources, which makes it much easier to keep the documentation consistent with the source code.Ī perhaps worse scenario is your company purchasing some code from a third-party vendor with scanty or no documentation. In fact, if you’ve ever used the popular Qt GUI or any project created with Qt, you’ve probably browsed a Doxygen-generated HTML page.Īs soon as any small project has more than three or four programmers working on it, the need for some explanation about how the functions work arises. Whether you call them hooks, functions, entry points, subroutines, or what-have-you, the need to document them well arises simultaneously. Any successful commercial code spawns vertical applications that need bits and pieces of its API.
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |