我使用Doxygen的三重斜杠语法来标记我的C++代码。有出现的两个重要案例:1)block标记注释，它是行中唯一的元素，可能或者可能不会开始向左齐平；例如classfoo///Aonesentencebriefdescriptionoffoo.Theelaborationcan///continueonformanylines.{...};voidfoo::bar///Aonesentencebriefdescriptionofbar.Theelaborationcan///continueonformanylines.()const{...}2)始终跟在一定数量的C++后面的尾随标
我在C++项目上使用Doxygen1.8.13。通常，我希望Doxygen记录我的宏。但是，我显然不希望它记录我的头文件includeguards:#ifndefFOO_H_#defineFOO_H_...etc...#endif//FOO_H...但是默认情况下，Doxygen确实为它添加了一个文档条目。我know我可以解决这个问题:///@cond#ifndefFOO_H_#defineFOO_H_///@endcond...etc...#endif//FOO_H但我不想在每个头文件中都添加两行无用的代码!有什么我可以做的吗？doxygen.cfg内容:DOXYFILE_ENCOD
假设我有:#defineMY_MACRO(FOO)voidFOO();MY_MACRO(hi);MY_MACRO(hey);MY_MACRO(hello);#undefMY_MACRO我希望通过doxygen扩展宏，我可以通过正确的方式配置它来实现:ENABLE_PREPROCESSING=YESMACRO_EXPANSION=YESEXPAND_ONLY_PREDEF=YESEXPAND_AS_DEFINED=MY_MACRO这使我能够在doxygen输出中看到宏的扩展结果作为记录的API(函数hi、hey和hello).到目前为止一切都很好。但问题是，doxygen也将MY_MAC
我正在研究基于phpdoc生成文档的不同解决方案，Doxygen看起来很棒，但到目前为止搜索受到严重限制。例如，我搜索字符串“session”，它给了我2个结果:sessionExistsLib_SessionsessionMatchesIpLib_Session同一个类还有一个方法叫getSession，我好像找不到。不仅如此，类(class)本身的名称中也有“Session”，但它不在搜索结果中。Doxygen是否可以通过任何方式实际搜索这些方法/类，或者它是否设计为功能有限？ 最佳答案 为了回答我自己的问题，我发现切换到Ser
我遇到了PHP5.3命名空间和Doxygen注释的问题。例子:/***SampleMethod**@paramstring$output*@return\Project\Lib\Rest*/Doxygen给我以下警告:warning:Foundunknowncommand`\Project'warning:Foundunknowncommand`\Lib'warning:Foundunknowncommand`\Rest'我该怎么做才能解决这个问题或关闭\commands并只使用@commands 最佳答案 尝试转义反斜杠，即使用/
我有一个简单的问题，我无法通过挖掘Google找到它。我正在将我的项目文档从phpDoc移动到Doxygen，但我不知道如何编写@license和@copyright在一起。在我的概念中，@copyright是为我的“公司”(还不是真实的:P)名称而设计的，@license我正在开发的方式可以被使用:许多CreativeCommons组合之一，GNU、MIT、BSD，“在许可下”... 最佳答案 基于Chris'answer，您可以使用\par命令创建一个类似于内置\copyright命令的block。例如，别名如下:ALIASES
关闭。这个问题需要更多focused.它目前不接受答案。想改进这个问题吗？更新问题，使其只关注一个问题editingthispost.关闭4年前。Improvethisquestion我正在查看PHPDoc的文档，但找不到一个好的方法来记录我发送到各种方法的Post变量。因此，我开始研究Doxygen，希望它能为我提供一种更好的方法来记录所有这些变量。我的代码涉及到很多AJAX请求，所以大部分变量都是通过post发送的。有什么好的方法可以让我记录doxygen中的post变量吗？我无法确定仅使用标准参数标签运行时是否会出现错误。如果没有，是否有其他记录员可能会在此过程中提供帮助？还是我
我在尝试记录我的项目时遇到了一个奇怪的问题。我有以下代码://!Setdefault::$actionforcalledcontroller.Ifnoactioniscalled,default(index)willbeset.$action=isset($_GET['action'])?$_GET['action']:'index';if($action){echo'something1';}else{echo'something2';}//!Setdefault::$action2forcalledcontroller.Ifnoactioniscalled,default(inde
我正在尝试为参数数量不受限制的函数编写doxygenblock注释，然后找不到合适的标签。提供的参数应该都是字符串，它们将在函数中连接起来形成一个新的字符串。doxygen标签的正确用法是什么？ 最佳答案 我经常在phpdoc中看到的模式(doxygen理解的格式)是:/***Shortdesc.*Longdesc.Longdesc.Longdesc.Longdesc.*@parammixed$somethingDescription*@parammixed...Description*/functionfoo(){...}是的，字
我很想知道是否可以通过doxygen将它们放入生成的html文件中的方式在函数(c、c++、java)中添加一些注释。例如:function(...){do_1();/***Calldo_2functionfordoingspecificstuff.*/do_2();} 最佳答案 我不知道C，但我每天都在Objective-C中这样做，我在其中评论如下:///Thismethodperformthefollowingoperations:-(void)myMethodWith:(id)anObjectArgument{///-doo
