![]() ** Computes the average of the two passed values. Note that, like Javadoc, the doxygen comments come before the code block to be documented. A function might be commented as follows. Thus, we are going to use a program called doxygen, which works on a dozen different languages, including C++. Javadoc is great for Java code, but does not work for C++ code. The source code is then run through a program called javadoc (which comes with the Java SDK), and the full online HTML documentation pages that we are familiar with are then created. A tag is a special command that denotes the comment is about some specific aspect, such as the parameter type or return value. If you look at the code itself, there are a lot of comments with special "tags" in the source code. However, there exist a number of documentation tools that allow us to do a lot more with our comments. So far, all of our documentation has been via regular comments. When writing large amounts of code, it is important to document it, both for your understanding later, as well as for other people's understanding (such as the graders). If it is a different version, then the line numbers will likely change, although they should be somewhat similar. These differences should not make any difference for the tags we are using.Ī note about line numbers: the line numbers shown throughout this document are for Doxygen version 1.8.6 (not the most recent version!) to find out what version you have installed, run doxygen -v. The version currently installing on Ubuntu Linux (both in the lab and on Virtual Box) may be a different version. Note that the current version of doxygen, as of the writing of this lab (released June 2015, and current as of late 2015), is 1.8.10. But see the very last paragraph of this lab for Mac-specific details. It will likely be easier to run doxygen through VirtualBox. Go up to the Tutorials table of contents pageĪ Mac OS X note: doxygen on a Mac is very hard to install and configure. Of there are many doxygen commands you may use, see Doxygen for more details.PDR: Doxygen Tutorial PDR: Doxygen Tutorial ![]() Try to document more the WHY not the WHAT, since for the WHAT you can read the implementation.īut most of all: If you find documents not following this rule, do not leave them broken - fix them if you can or contact the author which you might get with git annotate Openwalnut.cpp * * \param s the scaling factor * \param v the vector to scale * * \return a copy of v, scaled by d * * \see otherFunc * * \note the returned vector is a copy of v * \problem consider numerical issues * * \reminder something to remember * * \todoīut for the latter (implementation documentation) just two slashes should be used: if( ( distance( gl_TexCoord.xyz, focalPoint2 ) ) > callBack = boost::bind( &rerunBuilder, this, _1 ) // NOLINT extra space before (, which is not a function call For the first, Doxygen comments in JavaDoc-style must be used, like this: /** * Scale a given vector. and documentation directly regard implementation. Documentation describing classes, functions, members, name spaces etc. Our Doxygen configuration will generate call/caller graphs, collaboration graphs and inheritance graphs with the GraphViz package. You may generate HTML file with our make targets like this: make doc ![]() We use Doxygen for our code documentation. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |