Upload JavaDoc into influence

Hi guys

I have generated a JavaDoc for my project and wanter to insert it into confluence.

As you know, once you create the JavaDoc for a project, to get a folger with a bunch of file along with the an index.html file. If you click on the index.html file, you then can browse through the classes documenations of your project.

I would like to upload the generated folder into Confluence so that people will be able to browse through just as I do on my local machine.

Is that possible with Confluence?

 

Best regards

Edmond

1 answer

Hi Edmond,

We host the Javadoc files in our Confluence installation. Our Confluence instance is accessible to registered users only and this way the same applies to the Javadoc files.

We do the following:

  • Put the Javadoc in a folder under <confluence installation directory>\confluence\ApiDocs
  • Modify <confluence installation directory>\confluence\WEB-INF\classes\seraph-paths.xml, add the following:
    <path name="ApiDocs">
        <url-pattern>/ApiDocs/*</url-pattern>
        <role-name>confluence-users</role-name>
    </path>
  • Modify <confluence installation directory>\confluence\WEB-INF\decorators.xml, add the following
    <url-pattern>/ApiDocs/*</url-pattern>

From Confluence you can now add a link to /ApiDocs/index.html to show the Javadoc files.

Hope this helps.

Regards,

Geert

Suggest an answer

Log in or Sign up to answer
Atlassian Community Anniversary

Happy Anniversary, Atlassian Community!

This community is celebrating its one-year anniversary and Atlassian co-founder Mike Cannon-Brookes has all the feels.

Read more
Community showcase
Kesha Thillainayagam
Posted Apr 13, 2018 in Confluence

We want to hear how your non-technical teams are using Confluence!

Hi Community! Kesha (kay-sha) from the Confluence marketing team here! Can you share stories with us on how your non-technical (think Marketing, Sales, HR, legal, etc.) teams are using Confluen...

2,804 views 26 10
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you