Doxygen定义自定义注释以与Unity“Tooltip”属性一起使用

时间:2018-02-06 04:54:56

标签: unity3d plugins configuration doxygen

我正在使用Doxygen(版本1.8.11)来记录Unity(版本2017.3.0f3)项目,到目前为止它运行良好。然而,这是一个我希望解决的小效率低的例子:

要求:

  1. 当我将鼠标悬停在公共字段上时,我希望Unity显示工具提示,其中包含有关字段内容的一些信息as seen in this image

    • [Tooltip("The room's center transform")]
  2. 我希望Doxygen记录字段并在文档中显示相同的信息as shown here

    • /// <value> The room's center transform</value>
  3. 要完成此操作,我目前需要在源代码中输入两次相同的信息(see here

    如何配置Doxygen来读取所有[Tooltip("...")]部分而不是所有/// <value>...</value>部分?

    如果使用内置功能无法做到这一点,我怎样才能开始编写Doxygen插件或扩展来配置Doxygen的解析器来实现这一目标?

    编辑:Doxygen版本1.8.11,Unity版本2017.3.0f3

0 个答案:

没有答案