如何从.jar文件中的源代码构建javadoc?

时间:2010-03-01 11:10:29

标签: jar documentation javadoc

我必须从 myCode.jar 构建包含源文件和类文件的Javadoc。 我可以不抽取罐子吗?

根据http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#classpath,我应该可以这样做:C:\>javadoc -d docs -classpath myCode.jar net\kem\jmx\CacheManagerMBean.java 但是,我收到以下错误:

javadoc: error - File not found: "net\kem\jmx\CacheManagerMBean.java"
[search path for source files: [myCode.jar]]
[search path for class files: [C:\Program Files\Java\jdk1.5.0_17\jre\lib\rt.jar, C:\Program Files\Java\jdk1.5.0_17\jre\lib\jsse.jar,
 C:\Program Files\Java\jdk1.5.0_17\jre\lib\jce.jar, C:\Program Files\Java\jdk1.5.0_17\jre\lib\charsets.jar, C:\Program Files\Java\jd
k1.5.0_17\jre\lib\ext\dnsns.jar, C:\Program Files\Java\jdk1.5.0_17\jre\lib\ext\localedata.jar, C:\Program Files\Java\jdk1.5.0_17\jre
\lib\ext\sunjce_provider.jar, C:\Program Files\Java\jdk1.5.0_17\jre\lib\ext\sunpkcs11.jar, C:\Projects\RenderClusterController\WebCo
ntent\WEB-INF\lib\makoRenderJMX.jar]]
[done in 360 ms]
1 error

看来,javadoc无法在jar中找到源文件。我相信有消息来源。

有什么建议吗?

1 个答案:

答案 0 :(得分:3)

一些初步测试表明它不起作用(至少在OpenJDK 1.6.0_20上,我在这里)。

所以,我查看了源代码(可在mercurial web-interface中浏览)。 Javadoc(在那里的版本,可能与我在这里的版本不同)在其操作中使用相当多的Javac,看起来两者都使用javax.tools.JavaFileManager接口来实现对其源文件的访问,特别是在子接口StandardJavaFileManager

This interface声称可以访问zip文件条目:

  

此文件管理器创建表示常规文件,zip文件条目或类似基于文件系统的容器中的条目的文件对象。

但是这里如何使用它(在JavaDocTool.getRootDocImpl()中):

  148                 String name = it.head;
  149                 if (!docClasses && name.endsWith(".java") && new File(name).exists()) {
  150                     JavaFileObject fo = fm.getJavaFileObjects(name).iterator().next();
  151                     docenv.notice("main.Loading_source_file", name);
  152                     JCCompilationUnit tree = parse(fo);
  153                     classTrees.append(tree);
  154                 } else if (isValidPackageName(name)) {
  155                     names = names.append(name);
  156                 } else if (name.endsWith(".java")) {
  157                     docenv.error(null, "main.file_not_found", name);
  158                 } else {
  159                     docenv.error(null, "main.illegal_package_name", name);
  160                 }

第一种情况适用于您使用.java文件的调用 - 但由于它不作为文件系统中的文件存在(new File(name).exists()返回false),这没有帮助,而您相反,第三种情况是“找不到文件”错误。

当用更合适的条件(如!fm.getJavaFileObjects(name).isEmpty())替换这个条件时,看起来它可以工作 - 前提是用JavaFileManager初始化上下文,实际上它看起来是jar / zip文件,我现在没有检查

因此,您将要么解压缩源jar,要么修补您的javac实现(最好将其贡献给主javac源)。