IJava icon indicating copy to clipboard operation
IJava copied to clipboard

Javadoc for custom jar

Open ThibTrip opened this issue 4 years ago • 2 comments

Hello, is it possible to get java doc with tab completion for my own jars? If it is, what do I have to do to make it work? See picture below. Thanks in advance!

issue_javadoc_ijava

Sadly, I can't show you too much about my package since it is private (work/business related...). But here is the "build" part of my POM I use to compile my package. With this there is actually a separate javadoc jar that is created. I tried importing the javadoc jar but that did nothing. I suppose the javadoc should be in the same .jar as the code for this to work?

<project xmlns="http://maven.apache.org/POM/4.0.0"
    <...>
    <build>
        <plugins>
            <plugin>
                <artifactId>maven-source-plugin</artifactId>
                <executions>
                    <execution>
                        <id>attach-sources</id>
                        <phase>deploy</phase>
                        <goals><goal>jar-no-fork</goal></goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>2.10.2</version>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                        <configuration>
                            <source>8</source>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <artifactId>maven-deploy-plugin</artifactId>
                <executions>
                    <execution>
                        <id>deploy</id>
                        <phase>deploy</phase>
                        <goals><goal>deploy</goal></goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
    </...>
</project>

ThibTrip avatar Jul 30 '20 10:07 ThibTrip

https://bugs.openjdk.java.net/browse/JDK-8186876

It looks like there is a bug in JShell and it is able to load only jdk javadocs. What you can get is only the signature of the methods, that's it.

padreati avatar Aug 25 '20 11:08 padreati

@padreati well spotted 👍 ! Guess we will have to wait.

ThibTrip avatar Aug 25 '20 16:08 ThibTrip