| 1 | = Trac Wiki Macro for rendering links to Javadoc urls = |
| 2 | |
| 3 | == Description == |
| 4 | |
| 5 | Original version by Matthew Good. |
| 6 | Migrated to work with Trac 0.11 |
| 7 | |
| 8 | Accepts one or two arguments separated by a comma. |
| 9 | |
| 10 | The first argument is the fully qualified Java class or package. |
| 11 | Classes are assumed to begin with an uppercase letter and packages |
| 12 | with a lowercase letter according to standard Java naming conventions. |
| 13 | |
| 14 | The second optional argument is the link text. |
| 15 | If the second argument is ommitted the class name is used, |
| 16 | or in the case of a package the full package name is used. |
| 17 | |
| 18 | |
| 19 | == Bugs/Feature Requests == |
| 20 | |
| 21 | Existing bugs and feature requests for JavadocWikiMacro are |
| 22 | [report:9?COMPONENT=JavadocWikiMacro here]. |
| 23 | |
| 24 | If you have any issues, create a |
| 25 | [http://trac-hacks.org/newticket?component=JavadocWikiMacro&owner=Andi new ticket]. |
| 26 | |
| 27 | == Download == |
| 28 | |
| 29 | Download the zipped source from [download:javadocwikimacro here]. |
| 30 | |
| 31 | == Source == |
| 32 | |
| 33 | You can check out JavadocWikiMacro from [http://trac-hacks.org/svn/javadocwikimacro here] using Subversion, or [source:javadocwikimacro browse the source] with Trac. |
| 34 | |
| 35 | == Example == |
| 36 | |
| 37 | Just register the urls in the javadoc.py: |
| 38 | |
| 39 | {{{ |
| 40 | commons_logging_url = 'http://commons.apache.org/logging/commons-logging-1.0.3/docs/api/index.html' |
| 41 | }}} |
| 42 | |
| 43 | and add a mapping to the urls: |
| 44 | |
| 45 | {{{ |
| 46 | urls = { |
| 47 | 'org.apache.commons.logging': commons_logging_url, |
| 48 | ... |
| 49 | } |
| 50 | }}} |
| 51 | |
| 52 | |
| 53 | Usage: |
| 54 | {{{ |
| 55 | [[javadoc(org.apache.commons.logging.LogFactory, LogFactory)]] |
| 56 | }}} |
| 57 | |
| 58 | == Recent Changes == |
| 59 | |
| 60 | [[ChangeLog(javadocwikimacro, 3)]] |
| 61 | |
| 62 | == Author/Contributors == |
| 63 | |
| 64 | '''Author:''' [wiki:Andi] [[BR]] |
| 65 | '''Contributors:''' |