Использование компилятора 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, поскольку он дает гораздо лучшие предупреждения (и более настраивается другими способами).

Поэтому я изменил определение maven-compiler-plugin в pom.xml на:

<plugin>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>2.3.2</version>
    <configuration>
        <compilerId>eclipse</compilerId>
        <source>1.6</source>
        <target>1.6</target>
        <compilerArgument>-warn:+boxing,enumSwitch,javadoc,hashCode</compilerArgument>
        <showWarnings>true</showWarnings>
        <showDeprecation>true</showDeprecation>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>org.codehaus.plexus</groupId>
            <artifactId>plexus-compiler-eclipse</artifactId>
            <version>1.8.2</version>
        </dependency>
    </dependencies>
</plugin>

В моем разделе <reporting> у меня есть:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.8</version>
</plugin>

До сих пор так хорошо. Я сделал 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 rendering Maven report:
[ERROR] Exit code: 1 - java.lang.StringIndexOutOfBoundsException: String index out of range: -15
[ERROR] at java.lang.String.substring(String.java:1937)
[ERROR] at java.lang.String.substring(String.java:1904)
[ERROR] at com.sun.tools.javac.jvm.ClassReader.simpleBinaryName(ClassReader.java:958)
[ERROR] at com.sun.tools.javac.jvm.ClassReader.readEnclosingMethodAttr(ClassReader.java:930)
[ERROR] at com.sun.tools.javac.jvm.ClassReader.readMemberAttr(ClassReader.java:909)
[ERROR] at com.sun.tools.javac.jvm.ClassReader.readClassAttr(ClassReader.java:1053)
[ERROR] at com.sun.tools.javac.jvm.ClassReader.readClassAttrs(ClassReader.java:1067)
[ERROR] at com.sun.tools.javac.jvm.ClassReader.readClass(ClassReader.java:1560)
[ERROR] at com.sun.tools.javac.jvm.ClassReader.readClassFile(ClassReader.java:1658)
[ERROR] at com.sun.tools.javac.jvm.ClassReader.fillIn(ClassReader.java:1845)
[ERROR] at com.sun.tools.javac.jvm.ClassReader.complete(ClassReader.java:1777)
[ERROR] at com.sun.tools.javac.code.Symbol.complete(Symbol.java:386)
[ERROR] at com.sun.tools.javac.code.Symbol$ClassSymbol.complete(Symbol.java:763)
[ERROR] at com.sun.tools.javac.code.Symbol$ClassSymbol.flags(Symbol.java:695)
[ERROR] at com.sun.tools.javadoc.ClassDocImpl.getFlags(ClassDocImpl.java:105)
[ERROR] at com.sun.tools.javadoc.ClassDocImpl.isAnnotationType(ClassDocImpl.java:116)
[ERROR] at com.sun.tools.javadoc.DocEnv.isAnnotationType(DocEnv.java:574)
[ERROR] at com.sun.tools.javadoc.DocEnv.getClassDoc(DocEnv.java:546)
[ERROR] at com.sun.tools.javadoc.PackageDocImpl.getClasses(PackageDocImpl.java:154)
[ERROR] at com.sun.tools.javadoc.PackageDocImpl.addAllClassesTo(PackageDocImpl.java:170)
[ERROR] at com.sun.tools.javadoc.RootDocImpl.classes(RootDocImpl.java:178)
[ERROR] at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:96)
[ERROR] at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.start(AbstractDoclet.java:64)
[ERROR] at com.sun.tools.doclets.formats.html.HtmlDoclet.start(HtmlDoclet.java:42)
[ERROR] at com.sun.tools.doclets.standard.Standard.start(Standard.java:23)
[ERROR] at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
[ERROR] at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
[ERROR] at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
[ERROR] at java.lang.reflect.Method.invoke(Method.java:597)
[ERROR] at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
[ERROR] at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
[ERROR] at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
[ERROR] at com.sun.tools.javadoc.Start.begin(Start.java:128)
[ERROR] at com.sun.tools.javadoc.Main.execute(Main.java:41)
[ERROR] at com.sun.tools.javadoc.Main.main(Main.java:31)
[ERROR] 
[ERROR] Command line was: "C:\Program Files (x86)\Java\jdk1.6.0_27\jre\..\bin\javadoc.exe" @options @packages
[ERROR] 
[ERROR] Refer to the generated Javadoc files in 'C:\Projects\SMF\framework\target\site\apidocs' dir.
[ERROR] -> [Help 1]
[ERROR] 
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException

Мой вопрос:

ОК, так что изменилось? Все сайты Javadoc и Maven очень хорошо строились, когда я использовал javac, но как только я переключился на компилятор Eclipse, Javadoc сработает.

Хуже того, он даже не говорит мне, какой класс вызвал его сбой, поэтому я даже не знаю, с чего начать эту отладку.

Очевидно, что пока это означает, что я не буду использовать компилятор Eclipse, и вместо этого я буду придерживаться javac. Но мне любопытно, почему это происходит, и что я могу сделать, чтобы исправить или обойти это.

Ответ 1

Наконец-то я получил некоторое время, чтобы заглянуть в это снова. maven-javadoc-plugin в конце javadoc.bat script при target/site/apidocs не работает target/site/apidocs, когда процесс javadoc.exe выходит из строя, и я смог найти оскорбительный пакет, обрезая список в файле packages, который передается в javadoc.exe.

Интересно, что проблемный код оказался источником Java, созданным компилятором Google Protocol Buffers. Это было удачно, так как было бы приемлемо просто полностью исключить источник из протобуфа из Джавадока.

Я добавил следующее определение под моими разделами <build> и <reporting> POM, и это решило мою проблему:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.6.1</version>
    <configuration>
        <excludePackageNames>com.mycompany.myproject.proto</excludePackageNames>
    </configuration>
</plugin>

Ответ 2

Обходным путем для этого было бы создание отдельного профиля для цели сайта. Чтобы вы могли определить разные компиляторы для разных целей.

Ответ 3

Возможно, javadoc.exe не использует ту же JRE, что и Eclipse. Установлены ли их другие JRE? Попробуйте запустить процесс javadoc.exe вручную и убедитесь, что он делает то же самое, вы можете получить фактический стек проблемы.

Ответ 4

Это может быть не ответ, а просто предложить идею.

Как насчет установки JDK в папке без места (я видел, что это C:\Program Files (x86)...). Java поддерживает пробелы в именах файлов, но, вероятно, некоторые из плагинов/инструментов/библиотеки, которые javadoc-инструменты просто не поддерживают его.

Ответ 5

Я предполагаю, что проблема в том, что javac и eclipse используют разные версии JDK для компиляции кода