Doxygen 开关

Question

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

我怎样才能实现这个目标？ 谢谢!

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 关键字。然而，我从未使用过它，并且认为创建一个真正有用的图表来解释路径需要做很多工作。