nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Show javadoc page inside confluence page

Jukka Vuento

Hi, we have problem with documentation. We use Confluence, JIRA and Jenkins at the moment and use confluence for documenting the project (classes etc). Now we would like to show javadoc pages from Jenkins inside Confluence page as a part of documentation for class or service in question. Is this possible without writing own macro/plugin? Or if this is not possible can we somehow show it in JIRA story and link to it. What do you guys and girls use in this kind of situations?

Accepted answers

All comments

Stephen Deutsch2

Hi Jukka,

You could probably just put it in an iframe. You can use the Content Formatting Macros for free, and it includes an iframe macro.

Justin Justin7

Doxygen is free (well, donations are nice).

This plugin (Doxygen in Atlassian Confluence) only costs a donation to Room to Read also. There's also a JIRA version.

https://www.youtube.com/watch?v=uISYPvAoegk

Jukka Vuento

Hi, thank you for answers. Problem with using iframe or similar is that javadoc is in structure including folders. So uploading it unzipped is not really what we are looking for. Is there a way to upload it as a zip file and then use html pages from inside it? We are trying to make it as easy as possible to keep documents in order so uploading zip file and using the class specs from the newest one automatically would be nice.

Teresa Hollidge

I'm interested in this as well. We currently attach multiple Javadoc zip files to a Confluence pages for our partner developers on our customer facing Confluence instance. It's not very elegant and we don't want to grant our partners access to our internal systems.

Justin Justin7

Teresa - I think you will be pleased with http://www.appfusions.com/display/DOXYGEN/Home Email info@appfusions.com to try it as it is based on the zipped set, maintaining all structure.

Brian K1

Justin - does the macro pick up .zip files? I tried this with our javadoc export and received: "you must upload a Doxygen archive file." What's it looking for?

Justin Justin7

We have mostly been using .tar or tar.gz files - but it should support .zips too. I saw your comment in the support queue and the developer is looking into it. He could not replicate the issue with his local zips from Doxygen, but I think he was adding something to the code to more explicitly accept .zips or something. I say a skype message that he was making the update and a new release - so check back.

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

confluence

javadoc