Changes for page API Reference

Last modified by Thomas Mortagne on 2024/03/27

<
From version < 389.1 >
edited by Thomas Mortagne
on 2013/05/07
To version < 390.2 >
edited by Sergiu Dumitriu
on 2013/05/24
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ThomasMortagne
1 +XWiki.Sergiu
Content
... ... @@ -3,7 +3,7 @@
3 3  #set($nameStable = $versionStable)
4 4  ##set($versionDev = "5.0-rc-1")
5 5  ##set($nameDev = "5.0 Release Candidate 1")
6 -#set($versionOldStable = "4.5.3")
6 +#set($versionOldStable = "4.5.4")
7 7  #set($nameOldStable = $versionOldStable)
8 8  
9 9  #macro(coreJavadocUrl $version)
... ... @@ -16,6 +16,12 @@
16 16  
17 17  XWiki's APIs are the methods that the XWiki development team consider safe for you to use (i.e. for which backward compatibility is guaranteed). They can be called from Java or directly from your wiki pages [[using a scripting language>>DevGuide.Scripting]] (Velocity, Groovy, Python, Ruby, etc).
18 18  
19 +{{info}}
20 +As users of the XWiki API you need to be aware of some important points:
21 +* You should never use a class having ##internal## in its package. It means this class is not a public API and XWiki developers can change it at any time. If you depend on such a class you're on your own and the XWiki Development Team doesn't guarantee its stability.
22 +* You should pay attention to the ##@Unstable## annotation. When you see code marked with this annotation it means it's a new public API that it still considered unstable and that can change at any time too. See [[Unstable Annotation>>dev:Community.DevelopmentPractices||anchor="H40UnstableAnnotation"]] for more details.
23 +{{/info}}
24 +
19 19  == Scripting Reference Documentation ==
20 20  
21 21  You can now browse the XWiki APIs using the **[[Scripting Reference Documentation>>SRD.Navigation||queryString="xpage=embed"]]**.

Get Connected