问题标签 [doclet]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
0 回答
287 浏览

java - 用于编码 UTF8 的 JAVA Doclet 错误 unamppable 字符

我需要为下面指定的 java 文件运行这个 javadoc 程序。当我运行它时,我会收到以下错误消息:

错误:用于编码 UTF8 的不可映射字符

经过几项研究后,我发现当它找到特殊字符(您的 java 文件的文档)时会发生此错误,我可以摆脱它们,但这不是最佳解决方案。

我的问题是,有没有办法使用 Java 文件中包含的任何特殊字符来处理文件?尝试使用不同的 econder,但找不到合适的。

使用的特殊字符(“”、-、©、°、⌐)

0 投票
1 回答
1231 浏览

java - 从 javadocs 制作一个 bitbucket 源 wiki

嗨,我正在为我们的应用程序使用相当大的内部 SDK。我配备了广泛的 Javadocs。现在我的目标是以某种方式从这些 javadocs 生成 .MD 文件,以便我可以直接将这些 .md 文件放入我的 bitbucket wiki。

有没有办法做到这一点或生成 bitbucket wiki 可以使用的任何其他文件格式?

0 投票
1 回答
1032 浏览

java - 以编程方式运行标准 Doclet

从理论上讲,应该可以从 Java 程序本身运行 javadoc 生成过程(如此处所述http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/standard-doclet.html#runningprogrammatically) . 我从这里获取程序并稍微更改它,如下所示。但是,当我从类的 mainmethod 调用 doTest 方法时,我总是从导致错误的执行函数中获取返回代码“1”。

我可以使用以下行生成 javadoc:

我的环境是带有 JDK 1.7.0_51 的 Windows。

0 投票
2 回答
886 浏览

java - 如何在 Maven 中指定不同版本的标准 DocLet?

背景:我有一个项目可以在具有 java 1.7.0 的机器上使用 maven 编译,但 javadoc 编译在另一台具有 java 1.8.0 的机器上失败。从 maven 的日志中,我可以看到一个正在使用“Standard DocLet version 1.7.0_40”,而另一个正在使用“Standard DocLet version 1.8.0”。

问题是:我怎样才能告诉 maven 使用标准 DocLet 的正确版本?

我已经在 maven-compiler-plugin 中将源代码和目标版本都设置为 1.7。

0 投票
1 回答
143 浏览

doclet - 如何更改标准 doclet 的输出?

我想稍微修改标准 doclet 的输出。但是我不想编写自己的新 doclet,因为我的更改并不是很大。

我一直在寻找教程,但只找到了用于创建新 doclet 的教程。这里也没有答案:

如何调整标准 doclet——而不是编写一个全新的 doclet?

如何扩展 JavaDoc 5.0 标准 doclet?

如何实现修改后的输出?

0 投票
0 回答
209 浏览

groovy - 如何创建自定义 groovy doclet?

我想在我的 groovy 源代码中创建一个自定义 doclet,但我找不到任何可能性,因为groovydoc工具没有-taglet参数。我在 API 中挖掘了一下,但没有运气。有没有办法编写自定义 doclet?

0 投票
1 回答
153 浏览

javascript - Is this JSDoc? What does it mean?

I'm using NetBeans with the HTML5 project archetype.

One of the autogenerated documentation blocks for my function (after typing /** <enter>) contains the following line:

  • @type @exp;generateErrorClass@pro;ctor|Function

The referent line is:

var UnmodifiableProxyError = generateErrorClass('UnmodifiableProxyError');

So, this is JSDoc, right? But I can't find any documentation that explains those @exp and @pro tags. Can someone identify and explain that line of documentation?

0 投票
1 回答
4119 浏览

swagger - 是否可以基于静态 swagger service.json 生成模拟实现?

我通过 Carma swagger-jaxrs-docletmaven 构建周期中生成 swagger service.json和其他resource.jsons。之后,我将工件与 swagger-ui 一起部署在 Web 服务器上,我可以查阅生成的文档。这意味着我没有在我的应用程序中部署 swagger bean!

由于 swagger 主要部署在您的 API 实现中,我想知道 swagger-ui 采用哪种方法使文档可执行。它是从 swagger-ui 文档重定向到真正的实现,还是基于 service.json 创建一个模拟后端?我已经读到可以基于 service.json 在 node.js 中创建一个后端,但我不知道如何在网页中执行它。如果可以从网页内,我什至现在都不知道?

0 投票
0 回答
157 浏览

java - 如何在标准 doclet 的包装器中设置 javadoc 选项?

UMLGraph doclet UmlGraphDoc首先运行标准 Java doclet,代码如下:

然后修改结果以添加 UML 类图。

UMLGraph doclet 引入了许多自定义标签,例如@depend@has。可以使用Taglet-taglet接口指定自定义标签,并使用和选项传递给 javadoc -tagletpath。我的问题是:当从另一个 doclet 调用标准 doclet 时,如何将这些选项指定给标准 doclet?

以下是我探索过的一些事情:

  • javadoc Taglet 管理器提供了一种addCustomTag方法,但这不是公共 API。
  • 实现com.sun.tools.doclets.Configuration该类可以允许指定选项。在旧实现中有一些提示, 我发现这可以工作,但这似乎不是 javadoc 公共 API 的一部分。
  • 子类化(而不是调用)标准 doclet。提供的文档已过时并包含死链接。不是很放心。
  • 以编程方式运行标准 doclet,而不是从另一个 doclet 扩展它。目前尚不清楚这如何从另一个 doclet 工作。
0 投票
1 回答
19 浏览

command-line - -doclet 未被识别为内部或外部命令

我正在尝试为使用命令行的 XHTML Doclet 做一些教程,但它不能识别命令“-doclet”我对命令行不是很熟悉,所以我不知道如何从这里开始. 是否需要下载文件才能使 -doclet 正常工作?