# Ticket #977 (new enhancement)

Opened 6 years ago

Reported by: Assigned to: axton.grams@gmail.com anybody normal Request-a-Hack blocker burst@gmx.de, josh.moore@gmx.de, fcorreia@gmail.com, joerg.gottschling@quinscape.de 0.10

### Description

Similar to the Doxygen plugin, create javadoc plugin for java sources in the repository and make them available in the wiki.

## Change History

### 12/29/06 00:29:14 changed by boerst

I started to write a Macro to include javadoc into wiki pages, but then i realized that I can't even access the files in the repository. It seems that the Version Control API is only half implemented by now:

    def get_node(self, path, rev=None):
"""Retrieve a Node from the repository at the given path.

A Node represents a directory or a file at a given revision in the
repository.
If the rev parameter is specified, the Node corresponding to that
revision is returned, otherwise the Node corresponding to the youngest
revision is returned.
"""
raise NotImplementedError


### (follow-up: ↓ 3 ) 12/29/06 00:35:12 changed by boerst

i'm stupid. ignore that one :)

### (in reply to: ↑ 2 ) 02/07/07 11:35:02 changed by anonymous

i'm stupid. ignore that one :)

### (in reply to: ↑ description ) 02/19/07 15:22:46 changed by Daniel Werner <dwarf007 ... moesbar ... net>

Indeed. This would be a usefull plugin!

### 02/19/07 18:33:55 changed by Blackhex

IMHO the best solution would be to put all documentation plugins together as I said in #273. Unfortunately I'm not developing DoxygenPlugin now since priorities are elsewhere.

### 02/25/07 23:48:40 changed by boerst

• cc set to burst@gmx.de.

Thats how it could be done: Fetch the java file from Repository, save it to a tmp dir, use javadoc and jeldoclet to extract javadoc information to an xml file, then parse the xml. I've tested it and it works but i don't have the time to bring it anywhere near a useful macro. I'll attach the source. Note that this solution is really bad. Java needs to be installed on the server, and the file gets parsed everytime the page is accessed. The best solution would be to parse the source directly in python and then cache the results.

### (follow-up: ↓ 8 ) 05/30/07 11:20:33 changed by anonymous

• cc changed from burst@gmx.de to burst@gmx.de, josh.moore@gmx.de.

### (in reply to: ↑ 7 ) 09/17/07 18:49:07 changed by anonymous

How and where to install JavaDoc?.py?

### 08/23/08 20:37:52 changed by anonymous

• cc changed from burst@gmx.de, josh.moore@gmx.de to burst@gmx.de, josh.moore@gmx.de, fcorreia@gmail.com.

### 09/19/08 09:05:14 changed by joerg.gottschling@quinscape.de

• cc changed from burst@gmx.de, josh.moore@gmx.de, fcorreia@gmail.com to burst@gmx.de, josh.moore@gmx.de, fcorreia@gmail.com, joerg.gottschling@quinscape.de.

We would also like to use such a plugin.

### 08/30/09 17:30:12 changed by anonymous

In case you're using Subversion, you could also rely on its post-commit hook to generate the javadoc (or even doxygen) on each commit. Just have to be careful that while the documentation is being generated, a commit cannot trigger the generation of yet another documentation.

### 01/12/12 15:37:41 changed by ckonig

How could I include the JavaDoc? files into my wiki, when I have exported them with a post commit hook? And I mean include, like in using an IFrame.

### 01/13/12 01:09:46 changed by rjollos

You might take a look at JavadocWikiMacro and IncludeMacro.