documentation-generation相关内容

链接到外部主页

我制作了Doxygen文档，该文档本身使用标记文件机制引用了另一个文档。但是我现在想在其主页内链接到外部文档的主页。当然，我总是可以直接指定文件： ...使用[OtherDoc]（../../。 ./OtherProject/doc/html/index.html）... ... 项目彼此相对。但是尽管如此，我还是希望Doxygen自动执行此过程，因为它仍然需要知道外部文 ..
发布时间：2020-10-25 06:05:41 其他开发

有没有办法在protobuf（proto2）中创建类型别名？

是否可以创建protobuf标量类型的别名？ 例如，我想使用 Sequence 代替 string ，即使它们是等效的。 我的近期目标是制作文档（使用protoc-gen-doc生成）更容易理解。 理想情况下，该类型可以用支持类型检查的语言表示，但这不是必需的。 > 解决方案 这个答案会有些沉闷，但是： 不，我 您可以通过仅包含单个字段的子消息来模拟它，但这会 ..
发布时间：2020-10-25 06:05:21 其他开发

Doxygen是否可以处理MainPage.dox以外的页面

如果您将MainPage.dox文件放在Doxygen的搜索路径中，则会将其添加到源文档上方Doxygen / html中的输出中。但是您可以拥有MainPage.dox这样的多个文件吗？还是仅限于一个？ 解决方案 Doxygen将识别并解析任何带有* .dox扩展名的文件，并将其包含在结果文档中。这些文件将产生什么，取决于文件中的doxygen注释。例如，如果要修改主页，则需要这样的注释 ..
发布时间：2020-10-25 06:01:46 其他开发

Doxygen：空详细说明

上下文-Doxygen工具，使用C代码生成RTF文档。 在模块/组的文档中，即使没有，也会得到标题“详细说明”在某些特定的模块/组中提供了详细说明。 在生成的RTF文档中，这看起来很难看。 我尝试了“ ALWAYS_DETAILED_SEC = NO” ，但是有可能摆脱这种空的“详细描述”部分吗？不管用。我不能执行“ HIDE_UNDOC_MEMBERS = YES” ，因为组/ ..
发布时间：2020-10-25 05:59:26 其他开发

如何用参数记录方法？

如何使用Python的文档字符串来记录带有参数的方法？ 编辑： PEP 257 给出了以下示例： def复数（real = 0.0，imag = 0.0）： “”“形成复数。 关键字参数： real-实部（默认为0.0） imag-虚部（默认为0.0） “”“ 如果imag == 0.0并且real == 0.0：return complex_zero ... ..
发布时间：2020-10-25 05:51:47 Python

Doxygen EXTRACT_ALL = YES不会全部提取，还会显示未记录的警告

此刻，我正在对doxygen发疯，我希望它在第8层上不会太愚蠢，但我们会看到... 我想提取静态和未记录的内容。这就是为什么 EXTRACT_ALL = YES 的原因。但是EXTRACT_ALL似乎不能满足文档的意图。参见下面的示例。 在EXTRACT_ALL的文档中，输出中仍然有警告。 ＃如果如果EXTRACT_ALL标记设置为YES，即使没有可用的文档，doxygen也会假 ..
发布时间：2020-10-08 01:40:44 其他开发

狮身人面像，buildbot（以及代码覆盖率）。它们如何整合？

我有一个不太小的python程序包，它具有相当的历史记录，并以docstrings记录。在其开发过程中，我们引入了 buildbot ，后来又引入了詹金斯/哈德森。最近，我在 buildbot.cfg 中添加了 sphinx 食谱，以便从源头收集文档并保持最新的Web可访问文档。 到目前为止，效果非常好：每次我进行更改时，Jenkins都会注意全面检查该软件包，生成一个非常完整的概述并更新我 ..
发布时间：2020-10-04 20:33:58 Python

在SwaggerUI中包括客户端SDK使用示例

我一直在寻找一种工具，该工具可以帮助我解析JSON swagger文件(甚至YAML文件)并基于我已经尝试过: codegen(所以我确实在github存储库中有代码示例，但是我不知道如何在我的UI上动态获取它) 石板，但我想继续大张旗鼓 Widdershins 有人知道能够产生这种功能的第三方工具吗，还是我错过了Codegen或swagger-UI的某些东西? 还是应该在页面中 ..
发布时间：2020-09-05 22:15:43 其他开发

docutils和Sphinx之间是什么关系?

似乎有太多的Python文档工具.我遇到的另一个是epydoc. Sphinx似乎是事实上的标准，因为它用于生成正式的Python文档.有人可以帮我整理一下Python文档工具的当前状态吗? 解决方案 epydoc 和 Sphinx 是不同类型的工具. 它们的相同之处在于: 两者都通过 ReST . net/"rel =" nofollow noreferrer“> docut ..
发布时间：2020-07-30 21:15:21 Python

Visual Studio是否可以选择生成Javadoc样式注释的html文档?

Visual Studio是否可以选择生成Javadoc样式注释的html文档?如果是这样，必须采取哪些步骤来完成此任务? 在BlueJ中，有一个选项可以将Javadoc样式的注释转换为html文件. 就像下图所示的使用BlueJ的Java一样，我想对Visual Studio进行同样的操作: (来源: time-tripper.com ) 解决方案 您实际上是用Java指J ..
发布时间：2020-07-27 08:03:45 其他开发

VS2008:自动生成的文件和XML文档

这是一个烦恼，而不是一个问题.我的项目包含许多自动生成的文件(使用mgmtclassgen.exe).当我生成XML文档时，这些自动生成文件中的xml文档警告使我的注释精美的库陷入困境. 是否有办法要么a)禁止为这些文件生成文档，要么b)禁止仅针对一组文件的警告CS1591?我显然不想修改自动生成的文件，即使只是添加抑制编译指示也是如此. 该库和生成的代码都在C#中，并且我正在使用Vi ..
发布时间：2020-07-27 07:10:14 其他开发

如何自定义Docfx文档(主题或模板)?

我刚刚开始使用Docfx并设置了一些基本的概念性文档.现在，我想对主题进行一些调整(公司徽标，也许一些字体更改等). 官方文档仅给出了如何创建的高级描述一个新的模板.我以前从未使用过模板语言，因此，如果可能的话，我现在暂时避免使用这种语言. 我的问题是:我如何才能对默认主题进行一些小的调整，例如对CSS进行一些更改，或者添加外部资源(如字体真棒)? 我是否必须创建整个模板(或模板 ..
发布时间：2020-07-21 20:03:30 其他开发

VS2010:自动生成的文件和XML文档

这实际上只是在重新询问此问题被问到有关Visual Studio 2008的问题. VS2010是否提供任何功能来消除针对自动生成的代码的CS1591编译器警告? CS1591: Missing XML comment for publicly visible type or member 引用VS2008的问题: 这比一个更令人烦恼 问题.我的项目中包含一个数字 自动生成的文件 ..
发布时间：2020-07-15 02:42:08 其他开发

可以使用Doxygen，Sandcastle或其他文档生成器来记录XML吗?

我目前正在使用Sandcastle，Doxygen和JavaDoc为我编写的代码生成文档.是否可以使用这些软件包来记录XML模式?如果没有，是否有任何软件包(最好是免费的！)可以做到这一点?我可以自己编写文档，作为Doxygen或Sandcastle中的一个额外的概念性话题，但我宁愿使用一种工具为我做这件事！ 一个例子是(尽管我不是XML Schema的专家！): /// ..
发布时间：2020-07-06 05:17:00 其他开发

如何在PlantUML中生成带有颜色的图例?

我想根据特定条件为类图中的类上色，然后显示图例，该图例大致如下: 如果可以在PlantUML的legend和endlegend中添加HTML表，则可以通过更改单元格背景来实现.但是，添加HTML 不起作用.我还尝试使用 PlantUML的salt 插入表格，但找不到任何方法为表格的单元格着色. 有什么办法可以做到这一点? 解决方案 这并不完美，但是您可以使用克里奥 ..
发布时间：2020-07-03 19:22:15 其他开发

在PHP中自动记录REST API

phpDocumentor似乎是记录PHP代码的标准，尽管我想知道为什么多年来没有对其进行更新. 但是，它似乎不适合记录REST API的入口点； IE，是系统的最终用户感兴趣的，可从外部访问的入口点，而不是记录所有内部类等等，而这仅是api开发人员所感兴趣的. 我正在寻找可以说的东西，嘿，此方法可通过REST在此URL外部访问，这是它需要的GET或POST参数，它支持GET/POST/e ..
发布时间：2020-07-03 04:18:46 PHP

如何排除“ report.specification”来自Enterprise Architect中的报告？

我正在尝试为包装生成数据字典，但是我不知道如何排除作为我的数据字典的报告。 我得到了这个物品： 在我最后生成的PDF中： 我尝试过生成文档➜排除过滤器➜排除图表类型并选择扩展文档，维护和ModelDocument 我还尝试了生成文档➜排除过滤器➜E元素过滤器，并添加名称不等于 数据字典 但是我仍然得到“数据字典”页面作为数据字典的最后一页。 解决方案 我没有足 ..
发布时间：2020-06-11 02:00:58 其他开发

如何使用Python-Sphinx生成HTML文档？

我正在使用PyCharm进行Python项目，现在我需要生成相应的API文档。我正在使用 docstrings 记录代码方法和类。我读到了有关狮身人面像和Doxygen的信息，现在最推荐使用狮身人面像。我尝试配置Sphinx whitin PyCharm，但我没有运气。 这是项目结构： 这是与命令 Sphinx的I / O交互快速入门 C：\Python\Python36\Sc ..
发布时间：2020-06-06 19:45:54 Python

从邮递员集合中创建HTML文档

我已经开发了一个漂亮的扩展API，并且在Postman上有它，效果很好。现在，我必须生成一个html文档，以使其在/ docs以及其源代码中保持版本。 有没有工具或方法可以实现此目的？我真的不想写所有这些文档。 解决方案 我最近遇到了同样的问题，但没有发现任何问题。因此，我创建了一个简单的工具来执行此操作。这是一个用react.js编写的非常基本的javascript应用程序。目前， ..
发布时间：2020-05-30 02:12:09 其他开发