Doxygen开关

Question

我有一个相当大的switch语句(或者同样是一个很大的if语句)，我想在Doxygen中记录一些如何使用它，可能是在它的Caller Graph中，也可能是在某个流程图格式中。

我如何才能做到这一点？谢谢！

Answer 1

通常，doxygen仅用于记录整体功能。然而，我尝试了这样的东西。

/// Foo Function
void Foo(void)
{
   /// if switch \a condition equals
   switch (condition)
   {
      case VALUE_1:
      {
         /// - Path 1 \n
         /// Detailed explanation of path A.
         Foo1();
         break;
      }
      case VALUE_2:
      {
         /// - Path 2 \n
         /// Detailed explanation of path B.
         Foo2();
         break;
      }
      case VALUE_3:
      {
         /// - Path3 \n
         /// Detailed explanation of path C.
         Foo3();
         break;
      }
      case default:
      {
         /// - Default Case
         ///Something went wrong
      }
   }//end switch
}

这将在函数Foo下放置一个详细的描述，并为每个案例创建一个项目符号列表。记得用"-“来创建一个项目符号列表。至于生成调用图，您可以尝试使用\dot关键字。然而，我从来没有用过它，我认为要创建一个真正有用的图表来解释路径需要做很多工作。