问题标签 [javadoc]

我正在使用 apache ant 为我的项目生成 javadoc。我的一个包中有许多类，我只想展示一个。我该怎么做呢？这是我当前的代码。

（为清楚起见进行了简化）

我有一个 javadoc doclet，它需要一个额外的 jar 文件位于 doclet 的类路径中。要从命令行运行 doclet，我执行以下操作：

当我运行它时，它会在路径上找到 doclet 并执行它，但是 doclet 使用了一个需要在类路径上的附加 jar，所以最终，我得到了 ClassNotFoundException。

当我将命令行更改为：

它不再找到 doclet ( javadoc: error - Cannot find doclet class com.adventact.si.workflow.javadoc.ListClass)。因此，似乎 doclet 参数不接受路径列表，而只接受一个路径。

（请注意，这些命令行并不完整——我没有展示我如何设置类路径，因为它与 docletpath 问题无关，而且确实是垃圾邮件。）

你如何解决这个问题？

我正在使用 Eclipse 3.4.1。

我有一个由一堆 JAR 文件和一些 HTML JavaDoc 组成的外部库。我知道我可以将 HTML JavaDoc 附加到各个 JAR，方法是转到它们的 Properties 页面、JavaDoc 位置并将其设置在那里。

但是为每个单独的 JAR 执行此操作会很痛苦。是否有可能以某种方式一次完成它们？JavaDoc 的位置对它们都是一样的。

我正在使用 Eclipse 3.4.1。

虽然这听起来很奇怪，但我希望能够将多个 JavaDoc 位置附加到 Eclipse 项目中的同一个 JAR。这个特定的 JAR 具有来自两组 JavaDoc 的类。这样做的原因是它是一个 OSGi 包，它包含一个第三方 JAR，以及该 JAR 之上的一些其他第三方代码，以使其在 OSGi 中工作。

如果我拥有这两个包的源代码，并且在 Eclipse 项目中拥有该源代码，它就可以正常工作。但我希望能够在我只有 JAR 和 JavaDoc 的情况下让它工作。

我有一个小代码示例，我想将其包含在方法的 Javadoc 注释中。

问题是代码示例显示在 Javadoc 中，没有换行符，因此难以阅读。

我想我假设代码标签会处理换行符是错误的。在 Javadoc 注释中格式化代码示例的最佳方式是什么？

我参与了一个项目，其中公共 API 文档是一个明确的可交付成果。为了确保发布满足这个要求，如果文档覆盖率太低，我想确保我的 Ant 构建文件中的发布目标失败。

至少，每个具有公共或受保护访问权限的标识符都应具有适当的 Javadoc 标记和描述。例如，公共方法@param的每个参数都应该有一个标签，@return如果返回类型不是void，则应该有一个标签@throws，每个异常都有一个标签，以及单行描述。

我目前有使用 Cobertura 的 JUnit 代码覆盖率报告和故障条件，因此类似于文档的内容将是完美的。但是，如果无法检测到故障情况，则报告是合理的替代品。

文档必须采用 Javadoc 格式。没有其他格式（包括 Doxygen）是可接受的。

我是 Eclipse 的新手，不知道如何在编辑时显示 SWT 和 JFace 的 JavaDocs。

我该怎么做呢？谢谢！

将尽可能多的字节从 ByteBufferbbuf_src放入另一个 ByteBuffer的最有效方法是什么bbuf_dest（以及知道传输了多少字节）？我正在尝试bbuf_dest.put(bbuf_src)，但它似乎想抛出一个 BufferOverflowException 并且当我需要它们时，我现在无法从 Sun 获取 javadocs（网络问题）。>:(啊。

编辑：darnit，如果 bbuf_src 是只读缓冲区，@Richard 的方法（使用支持数组中的 put() bbuf_src）将不起作用，因为您无法访问该数组。这种情况下我能做什么？？？

我们公司和 Sun 的 javadocs 之间的网络似乎中断了。我在哪里可以获得给定包的 javadocs 副本，以便我可以保留自己的存储库以处理将来的网络中断？Sun javadocs 有镜像吗？

如何确保隐式换行符反映在输出 Javadoc 中，即换行符转换为<br/>标记？我觉得必须记住<br/>在我的评论的每一行添加标签很烦人。当然，如果没有<br/>标签，整个注释就会被压缩成一个不可读的块。

<br/>也许一个 doclet 只会用标签替换换行符？我google了很多，但没有想出任何东西。在开始编写自己的 doclet 之前，我想确保没有遗漏任何内容。