wiki:JavadocWikiMacro

Trac Wiki Macro for rendering links to Javadoc urls

Description

Accepts one or two arguments separated by a comma.

The first argument is the fully qualified Java class or package. Classes are assumed to begin with an uppercase letter and packages with a lowercase letter according to standard Java naming conventions.

The second optional argument is the link text. If the second argument is ommitted the class name is used, or in the case of a package the full package name is used.

Bugs/Feature Requests

Existing bugs and feature requests for JavadocWikiMacro are here.

If you have any issues, create a new ticket.

Download and Source

Download the zipped source from here. You can check out JavadocWikiMacro from here using Subversion, or browse the source with Trac.

Example

Just register the urls in the javadoc.py:

 commons_logging_url = 'http://commons.apache.org/logging/commons-logging-1.0.3/docs/api/index.html' 

and add a mapping to the urls:

urls = {
        'org.apache.commons.logging': commons_logging_url,
        ...
        }

Usage:

[[javadoc(org.apache.commons.logging.LogFactory, LogFactory)]]

Recent Changes

[8521] by rjollos on 2010-08-30 07:27:24
Added revision info to macro. Fixes #6571.
[4243] by Andi on 2008-09-08 09:42:57
delete duplicata
[4242] by Andi on 2008-09-08 09:41:46
Initial import

Author/Contributors

Author: Andi
Maintainer: Andi
Contributors: mgood

Last modified 4 years ago Last modified on Aug 28, 2010, 7:54:49 AM