![]() ![]() Moreover, you add a bunch of content to section 1 so now all of the code for this model is on page five. Now let’s say that you talk to your advisor and he suggests that maybe section 2 should come after section 3. * This is a detailed description of the model * brief Theoretical Model derived in section 2, on page 1 */ #ifndef CTHEORETICALMODEL_H_ #define CTHEORETICALMODEL_H_ /** * brief Definition file for CTheoreticalModel class For an example, lets say this is your paper: Some of your classes (if it’s object oriented) may implement certain models. In that case, some of your functions may implement certain equations. In particular, let’s say that you’re a grad student, in the process of writing a paper (and of course, you used LaTex… because, well, why wouldn’t you?) and you go and write some code to simulate or demonstrate some elements of that paper. Perhaps, even many such papers or reports. In that case, you may actually want your documentation to reference a paper, or a report that you’ve written. However, let’s say that (hypothetically of course) you’re an academic… and the code you write implements some theoretical design or model. For instance, if you use a library in your code and you want to include the library’s documentation with your own. ![]() ![]() One cool thing about it is the ability to reference external documentation. So, anyone who uses Doxygen to document their code knows that it’s pretty much the most amazing thing ever. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |