Changes between Version 5 and Version 6 of JavadocWikiMacro


Ignore:
Timestamp:
Sep 21, 2016, 7:56:02 PM (8 years ago)
Author:
figaro
Comment:

Moved example to functional description, tagged with license

Legend:

Unmodified
Added
Removed
Modified
  • JavadocWikiMacro

    v5 v6  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = Macro to render links to Javadoc urls
     3= Render links to the Javadoc pages
    44
    55== Description
    66
    7 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.
     7This is a Trac Wiki Macro for rendering links to the Javadoc pages. It accepts one or two arguments separated by a comma:
     8
     9Just register the urls in the javadoc.py:
     10
     11{{{
     12commons_logging_url = 'http://commons.apache.org/proper/commons-logging/javadocs/api-1.1.3/index.html'
     13}}}
     14
     15and add a mapping to the urls:
     16
     17{{{
     18urls = {
     19        'org.apache.commons.logging': commons_logging_url,
     20        ...
     21        }
     22}}}
     23
     24Usage:
     25{{{
     26[[javadoc(org.apache.commons.logging.LogFactory, LogFactory)]]
     27}}}
    828
    929The first argument is the fully qualified Java class or package.
     
    3151You can check out JavadocWikiMacro from [/svn/javadocwikimacro here] using Subversion, or [source:javadocwikimacro browse the source] with Trac.
    3252
    33 == Example
    34 
    35 Just register the urls in the javadoc.py:
    36 
    37 {{{
    38 commons_logging_url = 'http://commons.apache.org/logging/commons-logging-1.0.3/docs/api/index.html'
    39 }}}
    40 
    41 and add a mapping to the urls:
    42 
    43 {{{
    44 urls = {
    45         'org.apache.commons.logging': commons_logging_url,
    46         ...
    47         }
    48 }}}
    49 
    50 Usage:
    51 {{{
    52 [[javadoc(org.apache.commons.logging.LogFactory, LogFactory)]]
    53 }}}
    54 
    5553== Recent Changes
    5654