【问题标题】:doxygen alias with arguments: the (classical) linebr problem带参数的 doxygen 别名:(经典)linebr 问题
【发布时间】:2020-09-02 17:10:41
【问题描述】:
  • 考虑以下 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 ^^ @}"
  • 在以下 C++ 代码上运行 doxygen (1.8.18) 时
  /**
       \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.18 和 1.8.20 对其进行了测试,在这两种情况下我都会收到警告。看起来像一个错误。最好是在 doxygen 问题跟踪器中创建问题:github.com/doxygen/doxygen/issues/…

标签: warnings alias doxygen line-breaks


【解决方案1】:

基于 1.8.20 版本,我刚刚将提议的补丁推送到 github(拉取请求 8003,https://github.com/doxygen/doxygen/pull/8003)。

请注意:

  • args \3\4 之间的 ^^ 不应存在(将导致警告),\details 确保 \brief 已结束。这些警告有待进一步调查。
  • 也使用了物理换行符,因此必须小心使用。
  • \details 行的末尾也有 2 个空格,我不知道它们是不是故意的,但是(至少)行尾的 2 个空格意味着 Markdown 中的一个额外的新行语法。

编辑

2020 年 9 月 17 日编辑 上述提议的补丁都已集成在 github 上的 master 中

【讨论】:

  • 对不起:我想我是最新的 ecrins-fcazals> git log -n 1 commit e1d10844790b1f8386eada1ea73960b16e6bc440 (HEAD -> master, origin/master, origin/HEAD) 合并:72591fd5 fa32d44f 作者: Dimitri van Heesch 日期:Thu Sep 3 21:19:35 2020 +0200 Merge pull request #7998 from albert-github/feature/issue_7996 issue #7996 \ref 命令在降价表中损坏 别名是更新: ALIASES += "sbl_add_package_main_class{4}=\addtogroup \1-ref-manual ^^ @{ ^^ \class \2 ^^ \brief \3 \4 ^^ @}" 但我仍然收到警告。
  • 您是最新的主版本,提到的拉取请求是我提出的拉取请求,尚未集成到 doxygen 的主版本中。要么等到它们被集成到 doxygen 的主版本中,要么手动将它们应用到你的版本中(它们很小)。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2016-03-24
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多