Difference between revisions of "UNO @since Tags"

From Apache OpenOffice Wiki
Jump to: navigation, search
 
(modify since section for IDL)
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
OOo-related UNO documentation (i.e., for URE or SDK) uses <code>@since</code> tags for <code>autodoc</code> (C++, UNOIDL) and <code>javadoc</code> (Java) to specify that certain
+
OOo-related UNO documentation (i.e., for URE or SDK) uses <code>@since</code> tags for <code>autodoc</code> (C++, UNOIDL) and <code>javadoc</code> (Java) to specify that certain documented entities are only available from a given OOo or URE version onward.
−
documented entities are only available from a given OOo version onward.
+
  
−
For UNOIDL documentation, the relevant <code>@since</code> tags are written <code>@since OOo </code><var>x</var><code>.</code><var>y</var><code>.</code><var>z</var> denoting OOo version <var>x</var>.<var>y</var>.<var>z</var>.
+
For UNOIDL documentation, the <code>@since</code> tags are written &ldquo;<code>@since OOo </code><var>&lt;major&gt;</var><code>.</code><var>&lt;minor&gt;</var><code>[.</code><var>&lt;micro&gt;</var>]&rdquo; denoting OOo version <var>&lt;major&gt;</var>.<var>&lt;minor&gt;</var>.<var>&lt;micro&gt;</var> whereat the &lt;micro&gt; version number is used only if it is greater zero. See also [[Documentation/DevGuide/AppendixB/Special_Documentation_Tags|Special Documentation Tags]] in the Developer's Guide.
  
−
For C++ and Java documentation, the relevant <code>@since</code> tags are as follows:
+
For C++ and Java documentation, the <code>@since</code> tags are as follows:
−
<center>
+
 
{| border=1 cellspacing=0 cellpadding=5
 
{| border=1 cellspacing=0 cellpadding=5
−
| C++/Java <code>@since</code> tag
 
−
| OOo version
 
−
| URE version
 
−
|-
 
 
| <code>@since UDK 3.0.1</code>
 
| <code>@since UDK 3.0.1</code>
−
| OOo 1.0.<var>x</var>
+
| OOo 1.0.<var>z</var>
−
| N/A
+
 
|-
 
|-
−
| <code>@since UDK 3.1.0</code>
+
| <code>@since UDK 3.1</code>
−
| OOo 1.1.<var>x</var>
+
| OOo 1.1.<var>z</var>
−
| N/A
+
 
|-
 
|-
−
| <code>@since UDK 3.2.0</code>
+
| <code>@since UDK 3.2</code>
−
| OOo 2.0.0
+
| OOo 2.0
−
| URE 1.0
+
 
|-
 
|-
 
| <code>@since UDK 3.2.1</code>
 
| <code>@since UDK 3.2.1</code>
 
| OOo 2.0.1
 
| OOo 2.0.1
−
| N/A (will first show up in URE 1.1)
 
 
|-
 
|-
 
| <code>@since UDK 3.2.2</code>
 
| <code>@since UDK 3.2.2</code>
 +
| OOo 2.0.2
 +
|-
 +
| <code>@since UDK 3.2.3</code>
 +
| OOo 2.0.3
 +
|-
 +
| <code>@since UDK 3.2.4</code>
 +
| OOo 2.0.4
 +
|-
 +
| <code>@since UDK 3.2.5</code>
 +
| OOo 2.1
 +
|-
 +
| <code>@since UDK 3.2.6</code>
 +
| OOo 2.2
 +
|-
 +
| <code>@since UDK 3.2.7</code>
 +
| OOo 2.3
 +
|-
 +
| <code>@since UDK 3.2.8</code>
 +
| OOo 2.4
 +
|-
 +
| <code>@since UDK 3.2.9</code>
 +
| OOo 3.0
 +
|-
 +
| <code>@since UDK 3.2.10</code>
 +
| OOo 3.1
 +
|-
 +
| <code>@since UDK 3.2.11</code>
 +
| OOo 3.2
 +
|-
 +
| <code>@since UDK 3.2.12</code>
 +
| OOo 3.3
 +
|-
 +
| <code>@since UDK 3.2.13</code>
 +
| OOo 3.4
 +
|}
 +
 +
For reference, the relation between OOo versions and URE versions is as follows:
 +
{| border=1 cellspacing=0 cellpadding=5
 +
| OOo 2.0
 +
| URE 1.0
 +
|-
 
| OOo 2.0.2
 
| OOo 2.0.2
 
| URE 1.1
 
| URE 1.1
 +
|-
 +
| OOo 2.2
 +
| URE 1.2
 +
|-
 +
| OOo 2.3
 +
| URE 1.3
 +
|-
 +
| OOo 3.0
 +
| URE 1.4
 +
|-
 +
| OOo 3.0.1
 +
| URE 1.4.1
 +
|-
 +
| OOo 3.1
 +
| URE 1.5
 +
|-
 +
| OOo 3.1.1
 +
| URE 1.5.1
 +
|-
 +
| OOo 3.2
 +
| URE 1.6
 +
|-
 +
| OOo 3.2.1
 +
| URE 1.6.1
 +
|-
 +
| OOo 3.3
 +
| URE 1.7
 +
|-
 +
| OOo 3.4
 +
| URE 1.8
 
|}
 
|}
−
</center>
+
 
 +
The information on this page will be updated over time.  Also see http://www.openoffice.org/servlets/ReadMsg?list=dev&msgNo=12294 for further information.
 +
[[Category:Uno]]

Latest revision as of 19:02, 3 November 2010

OOo-related UNO documentation (i.e., for URE or SDK) uses @since tags for autodoc (C++, UNOIDL) and javadoc (Java) to specify that certain documented entities are only available from a given OOo or URE version onward.

For UNOIDL documentation, the @since tags are written “@since OOo <major>.<minor>[.<micro>]” denoting OOo version <major>.<minor>.<micro> whereat the <micro> version number is used only if it is greater zero. See also Special Documentation Tags in the Developer's Guide.

For C++ and Java documentation, the @since tags are as follows:

@since UDK 3.0.1 OOo 1.0.z
@since UDK 3.1 OOo 1.1.z
@since UDK 3.2 OOo 2.0
@since UDK 3.2.1 OOo 2.0.1
@since UDK 3.2.2 OOo 2.0.2
@since UDK 3.2.3 OOo 2.0.3
@since UDK 3.2.4 OOo 2.0.4
@since UDK 3.2.5 OOo 2.1
@since UDK 3.2.6 OOo 2.2
@since UDK 3.2.7 OOo 2.3
@since UDK 3.2.8 OOo 2.4
@since UDK 3.2.9 OOo 3.0
@since UDK 3.2.10 OOo 3.1
@since UDK 3.2.11 OOo 3.2
@since UDK 3.2.12 OOo 3.3
@since UDK 3.2.13 OOo 3.4

For reference, the relation between OOo versions and URE versions is as follows:

OOo 2.0 URE 1.0
OOo 2.0.2 URE 1.1
OOo 2.2 URE 1.2
OOo 2.3 URE 1.3
OOo 3.0 URE 1.4
OOo 3.0.1 URE 1.4.1
OOo 3.1 URE 1.5
OOo 3.1.1 URE 1.5.1
OOo 3.2 URE 1.6
OOo 3.2.1 URE 1.6.1
OOo 3.3 URE 1.7
OOo 3.4 URE 1.8

The information on this page will be updated over time. Also see http://www.openoffice.org/servlets/ReadMsg?list=dev&msgNo=12294 for further information.

Retrieved from "https://wiki.openoffice.org/w/index.php?title=UNO_@since_Tags&oldid=187551"
Personal tools