Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add automation for projects to create javadoc links #42

Open
dsyer opened this issue Oct 24, 2016 · 1 comment
Open

Add automation for projects to create javadoc links #42

dsyer opened this issue Oct 24, 2016 · 1 comment
Labels

Comments

@dsyer
Copy link
Contributor

dsyer commented Oct 24, 2016

This nice little service http://javadoc.io/ could be used to render our javadocs, but there are multiple jars per project. So there are 2 choices:

  1. Make a new page in each project's documentation that lists links to all javadocs, one per jar
  2. Publish an aggregate jar and make it appear in http://javadoc.io/. For that to work we'd have to know a little bit about the internals of the service (does it support this kind of aggregation?).

Option 1 is easier for us, but option 2 is more convenient for users.

@dsyer
Copy link
Contributor Author

dsyer commented Oct 24, 2016

I think a variant of option 2 will work (cf http://javadoc.io/doc/org.springframework.cloud/spring-cloud-commons-parent/1.1.4.RELEASE). The parent project can aggregate javadocs and publish them as a single jar. The only tricky thing is then knowing the name of the parent project, but users will never need to care, if they just follow links from the home page. Here's what I used to create the spring-cloud-commons-parent docs:

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <executions>
                    <execution>
                        <id>aggregate</id>
                        <goals>
                            <goal>aggregate-jar</goal>
                        </goals>
                        <phase>package</phase>
                        <inherited>false</inherited>
                        <configuration>
                            <aggregate>true</aggregate>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants