问题标签 [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 回答
3964 浏览

java - 如何使 javadoc doclava doclet 与 gradle 一起工作

我正在使用 java 插件构建一个带有 gradle 的项目,我还想使用doclava doclet构建 javadoc

这是模块的 build.gradle 的相关部分

当我运行 ./gradlew javadoc 时出现此错误

有人可以让它与 Gradle 一起使用 doclava 吗?

0 投票
0 回答
45 浏览

java - 带有阅读更多链接的 Maven 插件文档目标?

有没有办法缩短显示在 Maven 插件文档页面上的使用点下的文本?

我写了一个很长的 Mojo 描述,我不想在第一个使用页面上展示它。

那么有没有办法添加“阅读更多”链接或简单地缩短显示的文本?

更新:我在类描述中添加了一个表格,我不想在使用页面上显示这个表格。

0 投票
1 回答
6460 浏览

maven - maven-javadoc-plugin 覆盖中央存储库

我对 Maven Javadoc 插件和自定义 doclet 有疑问。

我正在使用 maven-javadoc-plugin v 2.10.1和一个自定义 doclet,它基本上是一个 maven jar 项目。

我还有一个settings.xmlcentral存储库定义为自定义工件的。

问题是,每当我运行 maven-javadoc-plugin 时,它都会尝试从 解析自定义 doclet 的依赖关系https://repo.maven.apache.org/maven2,而 doclet 本身则从自定义工件中解析。
调试输出也很奇怪,它说central存储库是https://repo.maven.apache.org/maven2snapshot存储库是我自定义的快照工件。
它的锁定就像 maven-jar-plugin 覆盖centralsettings.xml.

我怎样才能告诉maven-jar-plugin不要覆盖我的central存储库。

调试日志如下所示:

我必须剪掉一些 Stacktraces,并希望剪掉不必要的调试日志,因为我只有 30000 个字符。

这是带有 maven-javadoc-plugin 配置的父 POM

更新:这是我的settings.xml

我希望有人可以帮助我解决这个问题。

带着敬意

0 投票
0 回答
239 浏览

javadoc - 如何在 Eclipse 或 maven 中生成类、包 ... 到 pdf 的自定义 javadoc?

如何在 Eclipse 或 maven 中生成类、包 ... 到 pdf 的自定义 javadoc?

我尝试了很多方法也使用了 maven-pdf-plugin 和 pdfdoclet ......但是不成功或者我用了错误的方法?你能给我一些建议吗?或者一些指南,一些教程?...

提前致谢

0 投票
1 回答
1313 浏览

java - 无法生成自定义 javadoc;'找不到 doclet'

我正在尝试使用创建自定义 Javadoc 生成器Doclet,但遇到了一些问题。

我正在关注官方文档,最初在将tools.jar文件包含在我的项目中时遇到了麻烦,但我设法解决了这个问题。

我现在的问题是运行此命令后...

...我收到消息...

javadoc: 错误 - 找不到 doclet 类 ListClass

正如我所说,我大部分时间都在关注官方文档中的教程,但这里是我的代码供参考。

ListClass.java

并且MyClass.java

所以我要问的是为什么我会收到上面发布的错误。如果有人能够提供更全面的Doclet工作指南,那也很棒。


注意:我正在为我的项目使用 IntelliJ IDE。这是我的目录结构:

  • 。主意
    • ...
  • 出去
    • ...
  • 源代码
    • 列表类.java
    • MyClass.java
  • JavadocGenerator.iml
0 投票
1 回答
179 浏览

javadoc - javadoc doclet 和静态导致 NoClassDefFoundError

编译:javac -cp tools.jar;log4j-1.2.17.jar ListClass.java

跑步:javadoc -doclet ListClass -docletpath . -classpath log4j-1.2.17.jar;tools.jar ListClass.java

这将生成 NoClassDefFoundError。但是,如果我删除 static 关键字,它就可以正常工作。任何想法如何使用 static 关键字使其工作?

0 投票
1 回答
1291 浏览

jax-rs - Swagger UI 显示 JAX-RS 资源的错误状态代码

我有一个非常简单的删除方法:

如您所见,我使用 JavaDoc 标记来指定成功和错误响应代码。在该方法中,我创建了一个无内容响应(状态码为 204)。这是 swagger-doclet 生成的:

到目前为止,一切都很好:它将我的 JavaDoc 标记与成功和错误响应代码一起使用。此外,还有一种“响应”类型,似乎取自方法返回语句。现在,当我打开 Swagger UI 时,我得到了以下视图:

在此处输入图像描述

在顶部您可以看到“响应类(状态 200)”,其中“响应类”是正确的,但“状态 200”是错误的!在此方法中,我无处返回状态代码 200(OK)。我没有找到任何有效的解决方案来纠正这个输出。

我用什么:

  • 爪哇 8
  • Maven 3.3.9
  • 下拉向导 0.9.2
  • org.apache.maven.plugins.maven-javadoc-plugin 2.10.3
  • com.tenxerconsulting.swagger-doclet 1.1.3

如果你想尝试一下,完整的项目在 GitHub 上:https ://github.com/McPringle/moodini

获得正确的 swagger API 文档真的很棒。任何帮助表示赞赏。

非常感谢!

0 投票
1 回答
898 浏览

maven - 使用 maven 打包自定义 javadoc doclet

我已经编写了自己的 java doclet,并希望将其打包成一个 jar 文件以供以后使用。

我目前正在使用具有这些设置的 Maven 来生成它:

问题:
所有东西都正确打包到 jar 中,但我的来源丢失了。
如果我尝试做一个简单的mvn package事情,它会告诉我 sun 包不存在。

错误:com.sun.javadoc 包不存在

我认为最后一部分是为什么我无法在 jar 中找到我的来源的主要原因,因此我的问题是如何告诉 maven 忽略这些导入。

0 投票
0 回答
420 浏览

android-gradle-plugin - 带有 Doclava 无效标志的 Gradle Javadoc 插件自定义任务-link

我在我的库 build.gradle 中添加我的自定义 gradle 任务,并使用 Doclava 实现:

}

当我运行任务 gradle 给我错误javadoc: error - invalid flag: -link。但是当我删除 links & linksOffline 选项时,任务可以运行。另一个问题是提供的 PRIVATE 成员选项不起作用,生成的文档只显示公共成员。

有什么办法可以修复它,以便使用 Doclava doclet 我可以获得指向 Android 和 Java 参考的参考链接?

0 投票
0 回答
382 浏览

java - 如何在android studio中使用自定义'doclet'

这是我custom docleteclipse

现在如何doclet在 android studio 中编辑和使用它?

android studio中“生成JavaDoc”的图片