From version < 455.3 >
edited by Vincent Massol
on 2015/03/16
To version < 456.1 >
edited by Vincent Massol
on 2015/03/16
< >
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -6,11 +6,12 @@
6 6  ##set($versionOldStable = "5.4.7")
7 7  ##set($nameOldStable = $versionOldStable)
8 8  
9 -#macro(coreJavadocUrl $version)
10 -http://nexus.xwiki.org/nexus/service/local/repositories/releases/archive/org/xwiki/platform/xwiki-platform-oldcore/${version}/xwiki-platform-oldcore-${version}-javadoc.jar/!/index.html
9 +#macro(moduleJavadocUrl $repo $module $version)
10 +http://nexus.xwiki.org/nexus/service/local/repositories/releases/archive/org/xwiki/${repo}/xwiki-${repo}-${module}/${version}/xwiki-${repo}-${module}-${version}-javadoc.jar/!/index.html
11 11  #end
12 -#macro(renderingJavadocUrl $version)
13 -http://nexus.xwiki.org/nexus/service/local/repositories/releases/archive/org/xwiki/rendering/xwiki-rendering-api/${version}/xwiki-rendering-api-${version}-javadoc.jar/!/index.html
12 +#macro(fullModuleJavadocUrls $repo $module)
13 +[[$nameStable>>#moduleJavadocUrl($repo $module $versionStable)]] (stable)#if ($versionDev), [[$nameDev>>#moduleJavadocUrl($repo $module $versionDev)]] (dev)#{end}#if ($versionOldStable), [[$nameOldStable>>#moduleJavadocUrl($repo $module $versionOldStable)]] (super stable)#end
14 +
14 14  #end
15 15  {{/velocity}}
16 16  
... ... @@ -31,21 +31,18 @@
31 31  
32 32  You can get the maven module where to find a Java class by using [[XWiki Nexus Search page>>http://nexus.xwiki.org/nexus/index.html#nexus-search;classname~~]]. Put the complete class name and you will get all modules containing it. Nexus also allows you to see what's in those artifacts and read the javadoc.
33 33  
34 -== Other documentations ==
35 +== JavaDoc ==
35 35  
36 -The latest API documentation is available as JavaDoc:
37 +XWiki is made of various extensions/modules and each module offers API for both developers coding in Java and for Scripting written in wiki pages. In the future our goal is to have Javadoc links directly from each extension page located in the [[Extensions Wiki>>extensions:Main.WebHome]]. Right now you'll need to find the Javadoc JAR corresponding to the extension for which you're looking for API documentation.
37 37  
39 +For example:
38 38  {{velocity}}
39 -* [[Javadoc for XWiki Platform Core - $nameStable>>#coreJavadocUrl($versionStable)]] (stable)
40 -#if ($versionDev)
41 -* [[Javadoc for XWiki Platform Core - $nameDev>>#coreJavadocUrl($versionDev)]] (dev)
42 -#end
43 -#if ($versionOldStable)
44 -* [[Javadoc for XWiki Platform Core - $nameOldStable>>#coreJavadocUrl($versionOldStable)]] (super stable)#end
41 +* OldCore Javadoc: #fullModuleJavadocUrls("platform" "oldcore")
42 +* Model Javadoc: #fullModuleJavadocUrls("platform" "model")
43 +* Observation Javadoc: #fullModuleJavadocUrls("commons" "observation-api")
44 +* [[Rendering Javadoc>>rendering:Main.JavaDoc]]
45 45  {{/velocity}}
46 46  
47 -* [[Full Javadoc>>http://maven.xwiki.org/site/docs/]]
47 +The [[full Javadoc>>http://maven.xwiki.org/site/docs/]] is also available ({{info}}but only for old versions, we need to fix this{{/info}}).
48 48  
49 -You might also be interested in the [[Rendering Engine API JavaDoc>>rendering:Main.JavaDoc]].
50 -
51 51  Older Javadocs of XWiki can be found in our [[Maven Release repository>>http://maven.xwiki.org/releases/]]. For example for XWiki Platform Core Javadocs, check the files suffixed by ##javadoc## for the version you wish under [[this directory>>http://maven.xwiki.org/releases/org/xwiki/platform/xwiki-platform-oldcore/]].

Get Connected