Doxygen Example

Fortran comment lines starting with C> or !> will be indexed by Doxygen.

Here's an example of using common Doxygen tags.


C> @file apotnl.ftn -> By adding this line at line 1, it tells Doxygen to process this file.
C>
C> @author APOTNL (DIRK POREZAG, 1994, 1998) (MARK PEDERSON 1987-1994)
C> @brief APOTNL CALCULATES THE POTENTIAL ON THE MESHPOINTS WITHIN LSDA OR GGA
C> @note ATTENTION: FIRST TWO ARRAYS OF COMMON BLOCK TMP1 MUST BE IDENTICAL IN
C> DENSOLD AND APOTNL SINCE THEY ARE USED TO PASS DENSITY AND COULOMB POT
C>
C> @details Detail description of apotnl
C> @return returns some values
C> @param[out] TOTQNUM Total charge in apotnl
C> @param[in] LSPX Spin index? (=0 for DFT)
C> @param[in] IORBX FO index (=0 for DFT)
C> @param[out] RESULTS contains SIC energies and potentials for every FO.
C> @param[out] RESULTS(1) JRBSIC:FO Index
C> @param[out] RESULTS(2) XCH1: Charge
C> @param[out] RESULTS(3) XCH2: Charge (for RHOG down. Should be 0).
C> @param[out] RESULTS(4) ASY: The outermost mesh distance times coulomb
C> potential at that point.
C> @param[out] RESULTS(5) XEXX: Exchange enrergy
C> @param[out] RESULTS(6) -XCOU/2: Coulomb energy
C> @param[out] RESULTS(7) XDEL: Exchage-Correlation - Ecoul
C> @param[out] RESULTS(8) XENG: Exc-sic - Ecoul/2
C> @param[out] RESULTS(9) SIC_ENG: SIC energy (XENG *2/N)
C> @param[out] RESULTS(10) ERGXL: Local exchange
C> @param[out] RESULTS(11) ERGCL: Local correlation
C> @param[out] RESULTS(12) ERGXN: Nonlocal exchange
C> @param[out] RESULTS(13) ERGCN: Nonlocal correlation


Here is an example of how to use LaTeX with Doxygen

C> LaTeX test: Copy POT to SICP and build \f$\langle\phi_m| V_m^{SIC} |\phi_n\rangle \f$