Template:Javadoc:SE/doc: Difference between revisions

Revision as of 04:14, 29 March 2024

Latest revision as of 13:33, 27 May 2025

(2 intermediate revisions by one other user not shown)

Line 4:

Template for creating an external link into the [[Javadoc]] for a class in the current version of the [[Java SE]] API. This template should be used instead of an explicit URL to allow the link to be automatically updated to the latest API when this template is updated.

Please update [[Template:Javadoc:SE/Home_URL]] to update the javaJava version that this link sends users to.

If you would prefer to include a link to the javadocs of a specified version of Java, see [[Template:Javadoc]] (supports versions from JDK 11).

== Usage ==

Line 45 ⟶ 47:

|-

| <syntaxhighlight lang="wikitext">{{Javadoc:SE|class=Class<T>|

member=asSubclass(Class&amp;lt;U&amp;gt;)|

java/lang|Class|asSubclass(java.lang.Class)}}</syntaxhighlight>

| {{Javadoc:SE|class=Class<T>|member=asSubclass(Class&lt;U&gt;)|java/lang|Class|asSubclass(java.lang.Class)}}

Line 54 ⟶ 56:

|-

| <syntaxhighlight lang="wikitext">{{Javadoc:SE|package=java.lang|class=Class<T>|

member=asSubclass(Class&amp;lt;U&amp;gt;)|

java/lang|Class|asSubclass(java.lang.Class)}}</syntaxhighlight>

| {{Javadoc:SE|package=java.lang|class=Class<T>|member=asSubclass(Class&lt;U&gt;)|java/lang|Class|asSubclass(java.lang.Class)}}

Line 76 ⟶ 78:

! '''Type this''' !! '''To get this'''

|-

| <code><nowikisyntaxhighlight lang="wikitext" inline>{{Javadoc:SE|member=indexOf(int, int)|java/lang|String|indexOf(int,%20int)}}</nowiki></codesyntaxhighlight>

| {{Javadoc:SE|member=indexOf(int, int)|java/lang|String|indexOf(int,%20int)}}

|}

Line 83 ⟶ 85:

! '''Type this''' !! '''To get this'''

|-

| <code><nowikisyntaxhighlight lang="wikitext" inline>{{Javadoc:SE|member=indexOf(int, int)|java/lang|String|indexOf(int,int)}}</nowiki></codesyntaxhighlight>

| {{Javadoc:SE|member=indexOf(int, int)|java/lang|String|indexOf(int,int)}}

|}

# Including square brackets ([, ]) in the parameter types of method or constructor member arguments seems to break the template. Instead, replace square brackets with their [[numeric character reference]] escape codes, &amp;#91; and &amp;#93;, like this:

::{| class="wikitable"

! '''Type this''' !! '''To get this'''

|-

| <code><nowikisyntaxhighlight lang="wikitext" inline>{{Javadoc:SE|java/util|Arrays|sort(java.lang.Object&amp;#91;&amp;#93;)}}</nowiki></codesyntaxhighlight>

| {{Javadoc:SE|java/util|Arrays|sort(java.lang.Object&#91;&#93;)}}

|-

| <code><nowikisyntaxhighlight lang="wikitext" inline>{{Javadoc:SE | member=sort(Object&amp;#91;&amp;#93;)|java/util|Arrays|sort(java.lang.Object&amp;#91;&amp;#93;)}}</nowiki></codesyntaxhighlight>

| {{Javadoc:SE | member=sort(Object&#91;&#93;)|java/util|Arrays|sort(java.lang.Object&#91;&#93;)}}

|}

Line 100 ⟶ 102:

! '''Type this''' !! '''To get this'''

|-

| <code><nowikisyntaxhighlight lang="wikitext" inline>{{Javadoc:SE|jdk/javadoc/doclet|StandardDoclet|module=jdk.javadoc}}</nowiki></codesyntaxhighlight>

| {{Javadoc:SE|jdk/javadoc/doclet|StandardDoclet|module=jdk.javadoc}}

|-

| <code><nowikisyntaxhighlight lang="wikitext" inline>{{Javadoc:SE|java/awt|Graphics2D|module=java.desktop}}</nowiki></codesyntaxhighlight>

| {{Javadoc:SE|java/awt|Graphics2D|module=java.desktop}}

|}