【问题标题】:doxygen shows only one documentation in fortrandoxygen 在 fortran 中仅显示一个文档
【发布时间】:2013-04-17 21:14:08
【问题描述】:

我想在这里展示一个示例 fortran 代码:

SUBROUTINE CALHEAT(ISTL_)  

  ! DESCRIPTION:
  !! @ details
  !> Subroutine CALHEAT takes the information from the atmospheric boundary
  !>   file and the wind forcing file and calculates the net heat flux across
  !>   the water surface boundary. 
  !
  !   The heat flux terms are derived from a paper by Rosati
  !   and Miyakoda (1988) entitled "A General Circulation Model for Upper Ocean
  !   Simulation".  The heat flux is prescribed by term for the following
  !   influxes and outfluxes:
  !
  !     - Short Wave Incoming Radiation (+)
  !     - Net Long Wave Radiation (+/-)
  !     - Sensible Heat Flux (convection -)
  !     - Latent Heat Flux (evaporation +/-)
  !
  !   Two formulations of the Latent Heat Flux are provided.  The first is from
  !   the Rosati and Miyakoda paper, the second is an alternate formulation by
  !   Brady, Graves, and Geyer (1969).  The second formulation was taken from
  !   "Hydrodynamics and Transport for Water Quality Modeling" (Martin and
  !   McCutcheon, 1999).  The Rosati and Miyakoda formulation will have zero
  !   evaporative cooling or heating if wind speed goes to zero.  The Brady,
  !   Graves, and Geyer formulation provides for a minimum evaporative cooling
  !   under zero wind speed.
  !
  ! MODIFICATION HISTORY:
  !! @author
  !>   Date       Author             Comments
  !
  !
  !! @ param[in]
  !> VARIABLE LIST:
  !>
  !>   CLOUDT  = Cloud cover (0 to 10)<BR>
  !>   HCON    = Sensible heat flux (W/m2)<BR>
  !>   HLAT    = Latent heat flux (W/m2)<BR>
  !>   HLWBR   = Net longwave radiation (atmospheric long wave plus back
  !>             radiation, W/m2)<BR>
  !>   SOLSWRT = Short wave incoming radiation (W/m2)<BR>
  !>   SVPW    = Saturation vapor pressure in mb based upon the water surface
  !>             temperature<BR>
  !>   TATMT   = Temperature of air above water surface (deg C)<BR>
  !>   TEM     = Water temperature in cell (deg C)<BR>
  !>   VPA     = Vapor pressure of air at near surface air temperature (mb)<BR>
  !>   WINDST  = Wind speed at 10 meters over cell surface (m/s)<BR>
  !--------------------------------------------------------------------------------------------------

我想使用 deoxygen 显示作者、详细信息和参数。但是,doxygen 只输出参数。谁能指出我在这里做错了什么?

示例输出如下:

谢谢。

【问题讨论】:

    标签: doxygen


    【解决方案1】:

    Doxygen 使用特殊命令。完整列表可以在here找到

    例如

    \author { list of authors }
    \param [(dir)] <parameter-name> { parameter description } 
    

    对于您的代码,试试这个:

    \author Author name
    \param [in] CLOUDT Cloud cover (0 to 10)
    \param [in] HCON Sensible heat flux (W/m2)
    \param [in] HLAT Latent heat flux (W/m2)
    \param [in] HLWBR Net longwave radiation (atmospheric long wave plus back radiation, W/m2)
    \param [in] SOLSWRT Short wave incoming radiation (W/m2)
    \param [in] SVPW Saturation vapor pressure in mb based upon the water surface temperature
    \param [in] TATMT Temperature of air above water surface (deg C)
    \param [in] TEM Water temperature in cell (deg C)
    \param [in] VPA Vapor pressure of air at near surface air temperature (mb)
    \param [in] WINDST Wind speed at 10 meters over cell surface (m/s)
    

    【讨论】:

    • 注意 Fortran 例程参数也可以在变量之后添加文档,例如INTEGER, intent(in) :: CLOUDT !
    【解决方案2】:

    你必须在 SUBROUTINE 命令之前写下你的 doxygen 特定信息!请参阅the doxygen manual 了解更多信息。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2016-05-05
      • 1970-01-01
      • 2016-05-20
      • 2020-12-08
      • 1970-01-01
      • 2014-02-06
      • 2013-01-23
      • 2011-06-13
      相关资源
      最近更新 更多