问题标签 [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 投票
1 回答
400 浏览

enums - javado Doclet enum - 如何从枚举中获取可能的值以在我自己的 doclet 中使用?

使用 javadoc 时,枚举通常是这样记录的:

我的问题是,使用 JavaDoc Doclets,我可以获得该枚举的 classDoc ( Javadoc ClassDoc ),但我无法获得可能值的注释,甚至无法获得可能值本身。有人有想法吗?

0 投票
1 回答
628 浏览

javadoc - javadoc doclet:如何从类中获取属性

我正在玩 Doclets,我遇到了下一个问题。我想从一个类中获取属性,我认为参数方法会有所帮助。我的代码看起来像下一个(我正在为方法的返回类型这样做):

我得到的是

方法 myMethod 的 returnType 来自类型 MyMethodResponse

也许我错过了一些东西。ClassDoc.fields() 方法不会给我带来所有属性列表吗?有没有办法做到这一点?非常感谢你。

0 投票
1 回答
239 浏览

java - Javadoc doclet 可以识别空构造函数(编译器创建的默认构造函数)吗?

在创建软件应用程序时,我正在创建要插入到 Javdoc 的 doclet。我在使用 Javadoc 和创建的 RootDoc 时遇到的一个问题是它包含由编译器创建的空构造函数。有没有办法通过提供给我的 doclet 的 RootDoc 来防止这种情况发生或识别它们?当我发现 isSynthetic 方法时,我以为我昨晚在这方面取得了进展,但 nullary 构造函数显然不是合成的。

0 投票
1 回答
2660 浏览

javadoc - Gradle javadoc doclet。找不到 doclet

我是 Gradle 的新手,我正在尝试将我自己和美丽的 doclet 与 gradle 一起使用。我做了下一个任务:

有了这个,我总是成为下一个错误:

我知道有一个 options.docletpath ,它应该是我的 doclet 的路径(但是...... src 或类?),但由于缺乏解释,我无法理解我应该放在那里文档

谁能解释我如何正确设置 doclet 的路径,以便它找到我漂亮的 doclet?

谢谢你的时间!!

0 投票
1 回答
4241 浏览

javadoc - Gradle with javadoc doclet:错误 - 无效标志:运行我的 doclet 任务时的 -doctitle

我正在运行我的下一个 gradle-javadoc-doclet 任务:

(myJavadocs 只是一个生成基本 javadoc 的任务)我在控制台中运行它,如下所示:

当我这样做时,我收到下一个错误:

看起来“doctitle”标志是javadoc规范(Javadoc 1.3 Options)中的选项之一,但它不在早期的javadoc版本中(它是一个“title”标志)。我正在使用我的 JDK(1.6)中的 tools.jar(hte javadoc 所在的位置)。

有谁知道我做错了什么?

非常感谢您的宝贵时间!

跟进 -

看起来“doctitle”标签在标准 Doclet 上(我正在运行我自己的 doclet),并且它是由 gradle 添加的(我的 doclet 无法识别它)。有谁知道我怎样才能摆脱该标签,或者是否有任何方法可以将这些标签“包含”到我的 doclet 中?

0 投票
1 回答
2290 浏览

java - Javadoc doclet:获取“@Nullable”注释 (javax)。如何在 doclet 中获取该注释?

我正在创建自己的 doclet,并且我需要显示方法中的参数何时可以为空。为此,我想使用 javax.annotation 中的 @Nullable 注释。就像谷歌的人在这里所说的那样:

我的 Doclet 中是否有任何方法可以获取该 Phone 参数的“可为空”注释?

0 投票
1 回答
181 浏览

javadoc - 如何更改 Auriga Doclet 输出中包的顺序?

我正在使用Auriga Doclet 1.0 将我的 JavaDoc 文档创建为 PDF。

但是生成的 PDF 包含这样的包顺序:服务、响应、VO,基于字母顺序。

但我需要像这样订购它们:响应、服务、VO。

我怎样才能做到这一点?

0 投票
3 回答
1572 浏览

java - 使用特殊 doclet 运行 Javadoc 时出现模糊 IOException

可能是一个 doclet-implementation-specific 问题,但我相信它确实是我正在处理的 JavaDoc 配置问题。

我正在尝试让yDoc UML Doclet工作,以便它将为我的 Java 应用程序生成 UML 图,作为 Ant 构建的一部分。我下载了该项目(社区版)并尝试对其进行调整,build-sample.xml但无法使其正常工作。

这是我的项目目录结构:

这是build.xml

当我运行ydoc任务时,即使使用-v参数在“详细”模式下运行 Ant,我看到[ydoc]任务在 Ant 控制台中被调用,然后是一条日志语句,内容为“生成 Javadoc”,以及来自详细输出的大约 20 行反刍yDoc参数返回给我,然后是最后一条日志消息,上面写着“Javadoc 执行”。然后,以下令人震惊的模糊IOException

有什么方法可以从 Ant 中获取更多详细信息?要找出它在异常中引用的文件或目录?以前有任何 JavaDoc/yDoc 大师遇到过这种情况吗?我的项目目录结构是否设置不正确,或者与 Ant 构建所寻找的不同?我相信我的doclet/path属性设置正确,并使用了正确的路径分隔符(我在 Ubuntu Linux 上)。对于我的一生,我无法弄清楚从这里去哪里,或者如何诊断这里的潜在问题!提前致谢!

编辑/更新

感谢大家到目前为止的建议。我完全取消了 Eclipse(就构建而言,只是从命令行运行 Ant;现在这很好。当我这样做时,我得到了一个成功的构建(所以 Eclipse 至少部分是罪魁祸首),但是仍然没有 yDoc 生成。

现在,当我使用 verbos ( ) 选项从终端运行 Ant 时-v,我看到的是:

数百个看起来相同但类别不同的​​警告:

在数百个之后,我得到以下输出(我的源代码树中的每个包都有一个输出):

最后,详细构建输出的最后一部分:

此外,如果它正确执行,它应该将所有 JavaDocsuml-doclet/放在我的项目根目录下。它没有这样的事情!

所以看起来还有更多的事情发生:

  1. JavaDoc 看不到我的第 3 方依赖项(例如 Spring、Camel 等);因此列出了数百个警告
  2. 它找不到我要记录的任何来源

再次,赏金给任何可以帮助我完成这项工作的人。再次感谢迄今为止的所有帮助!

0 投票
1 回答
57 浏览

maven - 包含基于继承的类的 Java 文档

请注意,我已经编写了“Java 文档”,因为我不一定期望 javadoc 实用程序能够实现我所追求的(更不用说我正在使用的 maven-javadoc-plugin)。

我需要生成一个文档站点,其中仅包含扩展/实现特定接口的类,不幸的是,这些类似乎没有安排在逻辑包结构中,允许我通过过滤包路径来做到这一点。

有什么建议么?

0 投票
1 回答
2143 浏览

java - 如何使用引导主题生成 JavaDoc?

我想用Bootstrap 主题生成 api doc,但是如何实现呢?