Modify

Opened 8 years ago

Last modified 3 years ago

#977 new enhancement

JavaDoc plugin

Reported by: axton.grams@… Owned by: anybody
Priority: normal Component: Request-a-Hack
Severity: blocker Keywords:
Cc: burst@…, josh.moore@…, fcorreia@…, joerg.gottschling@… Trac Release: 0.10

Description

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

Attachments (1)

JavaDoc.py (2.3 KB) - added by boerst 7 years ago.
very limited javadoc macro. needs javadoc and jeldoclet

Download all attachments as: .zip

Change History (15)

comment:1 Changed 8 years ago 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

comment:2 follow-up: Changed 8 years ago by boerst

i'm stupid. ignore that one :)

comment:3 in reply to: ↑ 2 Changed 7 years ago by anonymous

Replying to boerst:

i'm stupid. ignore that one :)

Any news about this hack ? I'd need it too :)

comment:4 in reply to: ↑ description Changed 7 years ago by Daniel Werner <dwarf007 ... moesbar ... net>

Indeed. This would be a usefull plugin!

comment:5 Changed 7 years ago 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.

comment:6 Changed 7 years ago by boerst

  • Cc burst@… added

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.

Changed 7 years ago by boerst

very limited javadoc macro. needs javadoc and jeldoclet

comment:7 follow-up: Changed 7 years ago by anonymous

  • Cc josh.moore@… added

comment:8 in reply to: ↑ 7 Changed 7 years ago by anonymous

How and where to install JavaDoc.py?

comment:9 Changed 6 years ago by anonymous

  • Cc fcorreia@… added

comment:10 Changed 6 years ago by joerg.gottschling@…

  • Cc joerg.gottschling@… added

We would also like to use such a plugin.

comment:11 Changed 5 years ago 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.

comment:12 Changed 5 years ago by rjollos

  • Summary changed from JavaDoc Plugin for Trac to JavaDoc plugin

comment:13 Changed 3 years ago 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.

comment:14 Changed 3 years ago by rjollos

You might take a look at JavadocWikiMacro and IncludeMacro.

Add Comment

Modify Ticket

Action
as new .
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.