jjzjj

c++ - Doxygen 如何排除 C++ 类?

我想从Doxygen的文档中排除一个类。通常这些类位于同名文件中,但很多时候它们包含在其他类定义中。这主要用于以“_”或“Private”开头的类。如何告诉Doxygen排除C++类?提前致谢。 最佳答案 您可以使用the\condtag.在类定义之前,添加:\condHIDDEN_SYMBOLS在类定义之后添加:\endcond除非您在doxyfile中定义HIDDEN_SYMBOLS,否则不会记录\cond和\endcond标记之间的内容。您可以将HIDDEN_SYMBOLS替换为您喜欢的任何内容。

c++ - Doxygen 如何排除 C++ 类?

我想从Doxygen的文档中排除一个类。通常这些类位于同名文件中,但很多时候它们包含在其他类定义中。这主要用于以“_”或“Private”开头的类。如何告诉Doxygen排除C++类?提前致谢。 最佳答案 您可以使用the\condtag.在类定义之前,添加:\condHIDDEN_SYMBOLS在类定义之后添加:\endcond除非您在doxyfile中定义HIDDEN_SYMBOLS,否则不会记录\cond和\endcond标记之间的内容。您可以将HIDDEN_SYMBOLS替换为您喜欢的任何内容。

c++ - Linux 中 C++ 的类层次结构/依赖关系图生成器

是否有一些工具可以通过检查Linux中的C++代码来生成类层次结构/依赖关系图?我收到了一大堆C++文件,而这样的工具对我的帮助将是无价的理解源代码。我在理解它时有点纠结。 最佳答案 试试doxygen.它也可能随您的发行版一起提供。您可能需要GraphViz生成图表。有asimpleexample和output.这是doxygen生成的图例文件中的一个更复杂的例子:代码(注意:如果您只想生成图表,则不需要注释。):/*!Invisibleclassbecauseoftruncation*/classInvisible{};/*!T

c++ - Linux 中 C++ 的类层次结构/依赖关系图生成器

是否有一些工具可以通过检查Linux中的C++代码来生成类层次结构/依赖关系图?我收到了一大堆C++文件,而这样的工具对我的帮助将是无价的理解源代码。我在理解它时有点纠结。 最佳答案 试试doxygen.它也可能随您的发行版一起提供。您可能需要GraphViz生成图表。有asimpleexample和output.这是doxygen生成的图例文件中的一个更复杂的例子:代码(注意:如果您只想生成图表,则不需要注释。):/*!Invisibleclassbecauseoftruncation*/classInvisible{};/*!T

c++ - 是否存在用于编辑 doxygen 评论的 "wiki"?

已结束。此问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题,以便用事实和引用来回答它。关闭4年前。Improvethisquestion我正在开发一个相当大的开源RTS游戏引擎(Spring)。我最近添加了一堆可由Lua调用的新C++函数,我想知道如何最好地记录它们,同时也鼓励人们为很多现有的Lua调用编写/更新文档-出局。所以我认为,如果我最初可以将文档编写为靠近C++函数的doxygen注释,那可能会很好——这很容易,因为函数体显然准确地定义了函数的作用。但是,我希望使用引擎的游戏开发

c++ - 是否存在用于编辑 doxygen 评论的 "wiki"?

已结束。此问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题,以便用事实和引用来回答它。关闭4年前。Improvethisquestion我正在开发一个相当大的开源RTS游戏引擎(Spring)。我最近添加了一堆可由Lua调用的新C++函数,我想知道如何最好地记录它们,同时也鼓励人们为很多现有的Lua调用编写/更新文档-出局。所以我认为,如果我最初可以将文档编写为靠近C++函数的doxygen注释,那可能会很好——这很容易,因为函数体显然准确地定义了函数的作用。但是,我希望使用引擎的游戏开发

c++ - 在 doxygen 中对重载进行分组

在我的库中,我有很多形式的函数重载:///\briefDoesthing.//////\detailsThethingthatisdoneisveryspecial.templatevoiddo_stuff(constT&t);///\briefDoesthingrepeatedly.///\copydetailsdo_stuff()templatevoiddo_stuff(constT&t,std::size_tx);一般来说,这很有效,而且非常好,但创建的效果相同文档部分多次。我想要的是,将那些一起发挥作用。有详细的描述和每一个用它的简短描述注释的重载。我也不反感到可以执行此类操作

c++ - 在 doxygen 中对重载进行分组

在我的库中,我有很多形式的函数重载:///\briefDoesthing.//////\detailsThethingthatisdoneisveryspecial.templatevoiddo_stuff(constT&t);///\briefDoesthingrepeatedly.///\copydetailsdo_stuff()templatevoiddo_stuff(constT&t,std::size_tx);一般来说,这很有效,而且非常好,但创建的效果相同文档部分多次。我想要的是,将那些一起发挥作用。有详细的描述和每一个用它的简短描述注释的重载。我也不反感到可以执行此类操作

c++ - doxygen 一次注释多个变量

如果我有以下情况:/***@brief(x,y,z)pointsforblock*/intx,y,z;它只会为x生成该文档,在doxygen中是否有可能让它用一个评论来评论所有x、y和z?编辑按照envu的建议,我现在有以下(基于http://www.doxygen.nl/manual/grouping.html#memgroup)//@{/**somedocumentationhere*/intx,y,z;//@}或//@{/***@briefsomedocumentationhere*/intx,y,z;//@}然而,这两个仍然只是文档x。尝试使用不同的形式我还没有获得相同的文档字

c++ - doxygen 一次注释多个变量

如果我有以下情况:/***@brief(x,y,z)pointsforblock*/intx,y,z;它只会为x生成该文档,在doxygen中是否有可能让它用一个评论来评论所有x、y和z?编辑按照envu的建议,我现在有以下(基于http://www.doxygen.nl/manual/grouping.html#memgroup)//@{/**somedocumentationhere*/intx,y,z;//@}或//@{/***@briefsomedocumentationhere*/intx,y,z;//@}然而,这两个仍然只是文档x。尝试使用不同的形式我还没有获得相同的文档字