![]() The major rule of distributing content in a header is: Here I'd like to say a few words about where and how to create / group content in your headers. With these, you should be able to run ant in vm/doc directory and build documentation successfully. Doxyfile config file and build scripts: for DRLVM, located at drlvm/trunk/vm/doc.The problem lacks investigation, but it seems that 1.4.* and earlier versions do not support some valuable features. The currently published doc bundles use the version 1.5.1. Checked out source tree with the files you want to parse.To be able to generate comments by using Doxygen, you will need to have the following: For example, you don't need Apache Ant to build the docs for classlib as you do for drlvm. ![]() ![]() We don't have a unified Doxygen reference building process at the moment. The guidelines below are for those who wish to improve the comments in source code and see how Doxygen parses them. Please note that the reference for DRLVM is already available on the website, and class library docs are (hopefully) soon to come. We're not trying to impose a way of writing or a specific coding style, but rather agree on some common rules that would work for everyone. You are welcome to use, add or edit guidelines published on this page. We're running the initiative of getting a nice reference for DRLVM Interface Reference and Java class library reference, and our current experience shows that some specific conventions should be followed to get easily readable, complete and useful documentation. This page features tips and suggestions on writing good comments in header files to be parsed by Doxygen. Guidelines on Writing Good Code Comments to be parsed by Doxygen
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |