问题:如何使用Doxygen记录Ruby代码?免责声明:我知道ruby已经有一个内置的文档系统,可能还有其他方法可以做到这一点,但我操作的具体限制是如何让Doxygen完成这项工作(假设它是可能的). 最佳答案 简短的回答,没有。长答案,仍然没有。Doxygen最终会用于Ruby,但我不认为它会很快发生。短期内,您只能使用RDoc或YARD。 关于ruby-如何使用Doxygen记录Ruby代码?,我们在StackOverflow上找到一个类似的问题: h
我有一个非常大的类,它有很好的记录。Doxygen用于生成HTML文档,但对于此类,HTML文件很大~12MB,这对我来说太大了。发生这种情况是因为Doxygen在一个文件中列出了该类的所有文档,但在这种情况下,最好将类函数文档拆分在单独的页面中,以便有一个合理的页面。我想问的是:有什么解决办法吗?也许对此有特殊的选择/技巧?要么...也许我可以禁用此类的“正常”文档,然后将类函数文档复制到组织得更好的页面中?在这种情况下,我应该@copydoc那些函数,不是吗?你有什么建议? 最佳答案 这是可能的!有一个配置键:'SEPARATE
在我正在处理的元素中,我试图在文档、索引和生成的树中同时使用两种形式的导航。在查看doxygen帮助生成的XML布局表时,我知道我可以关闭出现在索引或生成的树中的选项卡的可见性。我的问题是,因为我没有禁用索引并将生成的树设置为YES,有没有一种方法可以仅针对索引将选项卡的可见性设置为“否”,同时让它们能够在树?谢谢编辑-如果有人不确定我的意思,我说的是两者兼而有之:DISABLE_INDEX=否GENERATE_TREEVIEW=是因此,如果我同时拥有它们,它们将在布局文件中共享相同的选项卡。我想知道我是否可以在索引上将某些选项卡的可见性设置为NO,同时让这些相同标签的可见性在生成的T
我写了一个库,它使用另一个第3方库。该第3方库在特定网站上在线提供。我已经成功地使用DoxyGen来记录我的项目,但是我很难让它生成指向第3方、在线、文档的链接。我发现我可以在我的文件中为这些类创建“虚拟”条目,并为它们生成页面,这些页面有一个指向在线文档的链接。这样做的缺点是,我被迫在我的文档上有一个页面,它只是一个链接。理想情况下,单击第3方类应将用户直接带到在线文档,而不是让用户通过“只做链接”页面。我试图为此使用外部标记文件,但在doxygen运行时不断出现错误,并且标记的类在输出中仍然是非链接。我还没有找到任何使用手动创建的标记文件来引用在线文档的示例,但是根据doxygen
为Doxygen处理编写的代码有这样的行是正常的。intmyVariable;///但是,当VisualStudio(例如VS2015)使用这些Doxygen注释准备的代码时,myVariable的工具提示信息将显示XML注释包含无效的XML:此位置不允许有空格。问题似乎是紧跟在“///”之后的“假设我们正在讨论已经遵循此Doxygen约定的现有代码体。很多地方已经这样写了。是否有一种方法可以调整或教导或设置VisualStudio,使其将此类注释视为前面项目的正常文档注释,以便它们出现在这些项目的工具提示中? 最佳答案 Doxyg
我当前的项目是一个C++应用程序。文档是用doxygen生成的,注释也有相应的格式。该项目还包括几个带有注释的xml资源文件。我想将它们包含在文档中。这是我想做的事情的例子:输入(我的应用程序使用的文件,myFile.xml):输出(doxygen生成的文档):myFile.xmlFileReferenceElementsdefault_settingsettingsusedbyclassMyClassatstartup[herescreenshot_defaultisinserted]advanced_settingsettingsusedbyclassMyClass-reserve
我目前正在使用SandcaSTLe、Doxygen和JavaDoc为我编写的代码生成文档。是否可以使用这些包来记录XML模式?如果没有,是否有任何(最好是免费的!)软件包可以做到这一点?我可以自己编写文档作为Doxygen或SandcaSTLe中的一个额外的概念主题,但我宁愿一个工具为我完成它!一个例子是(虽然我不是XMLSchema方面的专家!):///TopNode///ChildNode 最佳答案 据我所知,唯一可以记录XML模式的工具是DocFlex/XMLXSDDoc.坦率地说,我没有太多使用它的经验,但就我很少使用它而言
你好,Stackoverflow。正如标题所说,我对Doxygen有疑问。描述PowerShell脚本修改我的Doxyfile的PROJECT_NUMBER变量。然后它运行Doxygen,但它会生成HTML和LaTeX格式的文档,就像读取默认生成的Doxyfile一样。如果我在运行此脚本之前通过Notepad++手动修改Doxyfile,Doxygen可以完美运行,但一旦运行脚本,问题就会出现。我还要提到我的Doxyfile有:GENERATE_HTML=是GENERATE_LATEX=否GENERATE_MAN=是在实践中,Doxygen的行为是这样的:.\doxygen.exe-g
我正在尝试使用Doxygen记录一些使用MicrosoftSource-CodeAnnotationLanguage(SAL)的C++代码.但是,Doxygen不解析某些注释宏,例如_Success_,正确。对于示例函数注释,_Success_,Doxygen错误地将此宏解释为函数头/原型(prototype)。以下面包含函数注解标记的例子为例:/***@file*Examplewithfunctionannotation.*/#include#include/***@briefThisisafunction.*@paramiarandomvariable*@returnTRUEone
我目前在Linux上使用Doxygen1.5.5某些类文档在我的文档的Windows版本中不可用。我的库提供了几个类,一个是大写的,另一个是小写的,例如CONE和cone;因此,它们的类文档以classCONE.html和classcone.html的形式提供。由于Windows系统上的文件名不区分大小写,当ZIP文件的内容被提取到Windows系统时,大写类文档会覆盖小写类文档。由于最后恢复了大写类文档,因此它覆盖了具有相同名称的第一个小写文件。当我在Linux服务器上托管我的文档时,我能够显示这两个页面;然而,当其他人将内容提取到他们的Windows系统时,情况并非如此。有没有一种