带参数的doxygen别名:经典linebr问题

问题描述

  • 考虑以下doxygen别名:
ALIASES += "sbl_add_package_main_class{4}=\addtogroup \1-ref-manual ^^ @{ ^^ \class \2 ^^ \brief \3 ^^ \4 ^^ @}"

或等效地

ALIASES += sbl_add_package_main_class{4}="\addtogroup \1-ref-manual ^^ @{ ^^ \class \2 ^^ \brief \3 ^^ \4 ^^ @}"
  • 将doxygen(1.8.18)运行到以下C ++代码上
  /**
       \sbl_add_package_main_class{Molecular_potential_energy,T_Phi_psi_dihedral_angles_visitor,Defines iterator over all successive pairs of dihedrals.,\details Defines iterator over all successive pairs of dihedrals.  
       \tparam CovalentStructure The type of the input covalent structure
       }
    */  
    template <class CovalentStructure>
    class T_Phi_psi_dihedral_angles_visitor
    {
      
    public:
      
      typedef T_Phi_psi_dihedral_angles_visitor<CovalentStructure> Self;
      typedef CovalentStructure                               Covalent_structure;

      static inline Iterator begin(const CovalentStructure& C);

      static inline Iterator end(const CovalentStructure& C);
      
    };//end class T_Phi_psi_dihedral_angles_visitor
  • 我收到以下警告:
warning: the name '\_linebr' supplied as the argument of the \class,\struct,\union,or \include command is not an input file

这对我来说毫无意义,因为第二个自变量T_Phi_psi_dihedral_angles_visitor的格式正确。

我尝试添加/删除回车符,在别名中添加/删除^^ ...完全失败!

任何线索!?

非常感谢,弗雷德里克。

解决方法

基于1.8.20版本,我刚刚将一个建议的补丁程序推送到github(请求8003,https://github.com/doxygen/doxygen/pull/8003)。

进一步注意:

  • 参数^^\3之间的\4不存在(会导致警告),\details认为\brief是结束了。这些警告有待进一步调查。
  • 还要使用物理换行符,因此必须谨慎使用。
  • \details行的末尾还有2个空格,我不知道它们是否有意存在,但是(至少)行末2个空格表示额外的新行使用Markdown语法。

修改

编辑2020年9月17日 提到的建议补丁均已集成在github上的主服务器中

相关问答

依赖报错 idea导入项目后依赖报错,解决方案:https://blog....
错误1:代码生成器依赖和mybatis依赖冲突 启动项目时报错如下...
错误1:gradle项目控制台输出为乱码 # 解决方案:https://bl...
错误还原:在查询的过程中,传入的workType为0时,该条件不起...
报错如下,gcc版本太低 ^ server.c:5346:31: 错误:‘struct...