jltore.blogg.se - Doxygen fortran example

#Doxygen fortran example how to#
#Doxygen fortran example code#
#Doxygen fortran example download#

> I would like to point out a new project (not mine) for modern fortran documentation that, in my opinion, overtakes all other tool:

#Doxygen fortran example download#

Latter, you would have to download ROBODoc and run it, to generate theĭocs.) If you want to get a look at the ROBODoc formatting/etc. (However the documentation is not available online for the

For example checkout Stafano Zaghi'sĬan also find the generated output in a link in the README.md) and I still haven't made up my mind, but have seen Fortran However, it seems like Doxygen has someīuilt in scanning capabilities, whereas ROBODoc pulls everything from The output ofĭoxygen baffles me a bit, I find that top menu a bit unintuitive and Right now, I am choosing between doxygen and ROBODoc.

He has switched toĭoxygen for his documentation purposes, after Doxygen added better Website are outdated, but ARE up to date on GitHub. Seems he no longer uses or maintains this tool his projects on his I've been in contact with the FortranDOC author, Stefano Zaghi, and it

> I would also be interested in experiences. Sometimes I even read that documentation.

#Doxygen fortran example code#

Plus the front end fortran scanner uses that flex thing which I knowĪnyway, the code I document using that tool uses lots of F2003 stuff. Going I doubt I will have the time to do that for another 3.14 decades. Things into the shape I think they should be. Spend some time one day (more likely, one month or one quarter) beating Perhaps participating in its development.īecause of the sunk cost of my existing documentation I would like to I guess these changes indicate that other Fortran users exist and are One and he simply needs to spend a bit more time experimenting. Wacky, though there is also the possibility that this user is the wacky Nearest equivalent concept in other language models has been a bit Interfaces and procedure bindings across to what someone thought was the Versions its mapping of Fortran language concepts like modules, generic I'm not totally happy with it because some of the newerįeatures of the language still confuse it a little, plus in recent

Refers the reader to another entity, e.g.I use doxygen.

Logical, intent(in) :: test !> The logical expression to test. Documentation for parameters can also be placed right next to them:

Some warning related to the following Documentation of on or more parameters.

They are started either with \ or An exhaustive list can be found here

The tags used in the Doxygen documentation blocks are called "special commands".

The first paragraph is used as a short description in overview tables.

The documentation for a subroutine or function is placed above it.

Comments relevant for Doxygen have are started with !>.

Subroutine assert( test, failmsg, doStop )Ĭharacter(*), intent(in), optional :: failmsg !> assertStopOnFailed (References to other routines) !> If given, overrides the default behaviour set by assertSetStopMode. !> and bookkeeping is done for delayed stopping (see assertStopOnFailed). !> doStop Controls whether to stop execution. !> Can be modified with a prefix (see assertSetMsgPrefix) If omitted, a generic message is printed. !> print the fail message and possibly stop execution. !> A generic assertion, tests a given logical expression.

#Doxygen fortran example how to#

The following section shows how to use some of the documentation tags understood by Doxygen.