Tag: javadoc

单行上的Javadoc多个变量: 我有一个像下面这样的课…… class A{ /** * Blah blah */ Type1 var; /** * What do I do here? */ Type2 var11, var12; } 如果javadoc var11和var12都在同一行上怎么样？我很想知道这是否可行，我知道我可以将它们放在一条线上并从那里开始javadoc。

跨所有文件更新Javadoc版本和作者？: 我需要在我的项目中保持所有类Javadoc的@version标记以及@author标记。但是我不知道这么做的简单方法。是否有可以实现此目的的插件（最好是maven插件）？不，maven-release插件不会为我做这个。

当试图在rt.jar中显示类的Javadoc时，Eclipse会超时: 就在最近，我的Eclipse安装已停止可靠地显示rt.jar任何类的Javadoc信息。 hover文档和内容辅助都不能为任何非本地类型显示Javadoc。这个问题是零星的，Javadocs有时可以完美地工作几个小时。查看工作区日志，我看到如下消息： !ENTRY org.eclipse.jdt.ui 4 10001 2012-08-13 10:03:58.050 !MESSAGE Internal Error !STACK 1 Java Model Exception: Java Model Status [Timed out while retrieving the attached javadoc for String {key=Ljava/lang/String;} [in String.class [in java.lang [in C:\Program Files\Java\jre6\lib\rt.jar]]] ] at org.eclipse.jdt.internal.core.JavaElement.getURLContents(JavaElement.java:808) at org.eclipse.jdt.internal.core.BinaryType.getJavadocContents(BinaryType.java:1037) at org.eclipse.jdt.internal.core.BinaryType.getAttachedJavadoc(BinaryType.java:995) at org.eclipse.jdt.internal.ui.text.javadoc.JavadocContentAccess2.getHTMLContent(JavadocContentAccess2.java:463) at org.eclipse.jdt.internal.ui.text.java.hover.JavadocHover.getHoverInfo(JavadocHover.java:619) at org.eclipse.jdt.internal.ui.text.java.hover.JavadocHover.internalGetHoverInfo(JavadocHover.java:565) at org.eclipse.jdt.internal.ui.text.java.hover.JavadocHover.getHoverInfo2(JavadocHover.java:557) at org.eclipse.jdt.internal.ui.text.java.hover.BestMatchHover.getHoverInfo2(BestMatchHover.java:163) […]

开源工具，通过Maven2生成Javadocs，自动UML图如ydoc: 我想通过maven的网站生成插件生成javadocs，我希望在javadoc中创建并嵌入自动UML图表。 statsvn项目使用yDoc生成他们的UML文档，但我认为他们正在使用Maven1。 yDoc是一个商业共享软件产品，所以我不确定开源statsvn项目如何与它集成（或者如果有一个免费版本用于javadoc生成）。示例svnstat yDoc javadoc： ChurnPageMaker.java svnstat包含ydoc作为其Maven1报告生成的插件： project.xml maven-ydoc-plugin … yDoc文档说你可以使用Maven2的自定义javadoc doclet方法（但我无法弄清楚在哪里下载yDoc或者它是免费的）。似乎statsvn项目正在使用yDoc，所以我猜它是免费的？是否有任何其他开源Javadoc doclet生成器与Maven2集成以生成带有嵌入式类图的javadoc。

如何解决“javadoc：warning – 为包abc找到的包注释的多个来源”？: 我已经过时了，但我刚刚升级了我的项目以使用JDK 1.4中的JDK 1.5，现在运行mvn javadoc:javadoc ，遇到以下javadoc警告： [WARNING] javadoc: warning – Multiple sources of package comments found for package “com.a” [WARNING] javadoc: warning – Multiple sources of package comments found for package “com.b” [WARNING] javadoc: warning – Multiple sources of package comments found for package “com.c” [WARNING] javadoc: warning – Multiple sources of package comments found for […]

为什么@Documented注释具有运行时保留？: 据我所知，@ @Documented注释仅由javadoc生成器用于从源生成javadoc。保留类型应该是SOURCE ，但它是RUNTIME 。为什么？ @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Documented { }

Ant / Maven：“javadoc：warning – 获取URL时出错”: 我最近设置了我的构建服务器（Jenkins）来为Ant构建生成Javadocs。但是，无论我做什么，我都无法包含外部库的链接。当我尝试使用在线链接时，Ant返回： [javadoc] javadoc: warning – Error fetching URL: http://docs.oracle.com/javase/6/docs/api/package-list 当我使用脱机链接并引用包列表的本地副本时，它不会发出警告，但也不会生成链接。这种情况发生在我尝试链接的每个库中，而不仅仅是Java SE。以下是我的build.xml中链接的相应行：和：值得一提的是，服务器的互联网连接没有特别不寻常的配置。经过一番研究后，我发现我收到的警告在使用代理时很常见，但我找不到在直接连接的服务器上返回的任何情况。我还想提一下，我已经validation我的离线包列表位于正确的位置，并且可以通过构建文件的相对路径访问。编辑＃1：这显然也是Maven的一个问题，这表明Javadoc工具本身已被破坏。编辑＃2：值得一提的是我正在使用JDK 1.6 update 45进行编译。

如何使javadocinheritance适用于外部API？（与Maven2）: 当类重写具体方法或实现和抽象方法时，除非显式覆盖，否则Javadoc会自动inheritance。或者，至少该工具尝试这样做。它似乎不适用于链接的外部API。例如，当我在我的代码中实现java.util.Map或JRE中的其他内容时，javadocs不会从JRE javadocs / apidocsinheritance/复制。在我的具体情况下，我试图在Maven2 Javadoc插件中配置它，但是当我直接运行javadoc CLI工具时它是一样的。我的Maven2 Javadoc插件配置目前看起来像这样： org.apache.maven.plugins maven-javadoc-plugin 2.7 maven http://download.oracle.com/javase/6/docs/api 有关如何使这项工作的任何指示？

JDK类除了Javadoc之外还有其他任何规范吗？: JDK类除了Javadoc之外还有其他任何规范吗？如果是这样，在哪里？例如，考虑Collections.unmodifiableMap 。它的Javadoc没有提及线程安全性; 所以，从Javadoc开始，我不能认为将结果映射暴露给其他线程是安全的，而不需要采取我自己的一些特殊步骤来获得线程安全性。但恕我直言，任何现实的实现都会将内部地图存储在final字段中，因此在Java 5及更高版本中，只要内部地图是（在任何访问之间具有“先发生”关系），结果地图将是线程安全的生成的地图以及之前对内部地图的修改）。例如，这就是OpenJDK实现的function。那么，我怎么能弄清楚我是否可以轻易地假设一个给定的行为？

使用Eclipse编译器而不是javac会导致javadoc崩溃: 概要：我遇到了一个有趣的问题，我不太确定如何侦察它：我们的项目已经建好几个月了我更改了maven-compiler-plugin以使用eclipse编译器而不是javac 现在当我运行mvn site ， maven-javadoc-plugin失败了根据堆栈跟踪，看起来Javadoc工具正在崩溃Eclipse编译器创建的类文件有没有什么办法解决这一问题？如果没有，是否至少有进一步调试的方法？详细信息：我正在使用Java 1.6.0_27和Maven 3.0.2。我一直在使用javac编译器来构建我们的代码库，但我对尝试Eclipse编译器很感兴趣，因为它产生了更好的警告（并且在其他方面更易于配置）。所以我将pom.xml中maven-compiler-plugin的定义更改为： maven-compiler-plugin 2.3.2 eclipse 1.6 1.6 -warn:+boxing,enumSwitch,javadoc,hashCode true true org.codehaus.plexus plexus-compiler-eclipse 1.8.2 在我的部分中，我有： org.apache.maven.plugins maven-javadoc-plugin 2.8 到现在为止还挺好。我做了一个mvn clean install ，一切都很好，所有测试都通过，一切看起来都很棒。但是当我尝试运行mvn site ，当它到达Javadoc报告时，它失败了，似乎是一个Javadoc崩溃： [ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.0:site (default-site) on project framework: Error during page generation: Error […]