wiki:JavadocWikiMacro

Macro to render links to Javadoc urls

Description

This is a Trac Wiki Macro for rendering links to Javadoc urls. It accepts one or two arguments separated by a comma, see below for an example.

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.

defect

0 / 1

enhancement

1 / 3

Download

Download the zipped source from here.

Source

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
(more)

Author/Contributors

Author: Andi
Maintainer: Andi
Contributors: mgood

Last modified 7 months ago Last modified on Nov 25, 2015, 3:21:03 PM