Upload JavaDoc into influence

Edmond Sovoo

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

Geert_Graat

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">
&nbsp;&nbsp;&nbsp; <url-pattern>/ApiDocs/*</url-pattern>
&nbsp;&nbsp;&nbsp; <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