Generating javadoc for IntelliJ Community

Answered

Hello,

I'm trying to generate the Javadoc for IntelliJ Community source code (https://github.com/JetBrains/intellij-community).

I opened the project in IntelliJ, I build the project and then execute the option menu Tools/Generate Javadoc.

This is the output I got:

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/psi/cls/stubBuilder/InterfaceMethodParameters.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/refactoring/moveClass/jsp/before/WEB-INF/classes/TestTEI.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/psi/cls/stubBuilder/AnnotatedNonStaticInnerClassConstructor.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/plugins/java-decompiler/engine/testData/classes/pkg/R.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/plugins/java-decompiler/engine/testData/classes/pkg/TestMethodReferenceLetterClass.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/plugins/java-decompiler/engine/testData/classes/pkg/TestInnerSignature.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/codeInsight/interJarDependencies/lib1/A.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/refactoring/moveClass/jsp/after/WEB-INF/classes/TestTEI.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/psi/cls/stubBuilder/DoubleTest.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/compileServer/incremental/jasperValidation/jspDependent/exploded/WEB-INF/classes/a.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/plugins/java-decompiler/engine/testData/classes/pkg/TestMethodReferenceSameName.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/psi/cls/stubBuilder/module-info.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/psi/cls/stubBuilder/AnnotatedEnumConstructor.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/psi/search/searchInLibs/lib/classes/LibraryClass1.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/plugins/java-decompiler/engine/testData/classes/pkg/TestConstructorReference.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/psi/cls/stubBuilder/EnumMethodParameters.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/compileServer/incremental/jasperValidation/javaDependent/exploded/WEB-INF/classes/a.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/plugins/java-decompiler/engine/testData/classes/pkg/TestInnerLocal.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/psi/cls/mirror/pkg/DefaultPackage.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/plugins/java-decompiler/plugin/testData/LineNumbers.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/java/java-tests/testData/psi/search/searchInLibs/lib/classes/LibraryClass2.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/plugins/java-decompiler/plugin/testData/Navigation.class"

javadoc: error - Illegal package name: "/Users/carmen/IntelliJ-Community/idea/plugins/java-decompiler/plugin/testData/StructureView.class"

23 errors

Do someone knows what I'm missing here that the JavaDoc is not generated? I even run the file getPlugins.sh, but the problem remains.

Thanks in advanced,

Carmen

 

 

 

2 comments
Comment actions Permalink

Our test data is often created by broken code, which should be excluded when generating javadoc.

Why do you want to generate the javadoc actually? It won't provide more information than sources.

Thanks,

Anna

0
Comment actions Permalink

Thanks for your reply. I wanted to generate the Javadoc because I'm developing a plugin and I wanted to see while developing the methods and classes that were documented. For some reason, in my previous configuration I could not access to the full source code before, I verified the settings of my project and I updated again the source path of the SDK, like it is explained here: http://www.jetbrains.org/intellij/sdk/docs/tutorials/custom_language_support/prerequisites.html. Now everything works ok.

Thank you so much.

 

0

Please sign in to leave a comment.