[Libreoffice-commits] core.git: Branch 'aoo/trunk' - udkapi/com
Libreoffice Gerrit user
logerrit at kemper.freedesktop.org
Mon Dec 31 15:08:25 UTC 2018
udkapi/com/sun/star/beans/Pair.idl | 22 +++++++++-----
udkapi/com/sun/star/beans/Property.idl | 22 +++++++-------
udkapi/com/sun/star/beans/StringPair.idl | 8 ++++-
udkapi/com/sun/star/beans/XExactName.idl | 16 +++++-----
udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl | 26 +++++++++--------
5 files changed, 56 insertions(+), 38 deletions(-)
New commits:
commit 571180cadc5aeac746a90666c731cbd6473de551
Author: Matthias Seidel <mseidel at apache.org>
AuthorDate: Mon Dec 31 14:38:35 2018 +0000
Commit: Matthias Seidel <mseidel at apache.org>
CommitDate: Mon Dec 31 14:38:35 2018 +0000
Removed whitespace, fixed typos
diff --git a/udkapi/com/sun/star/beans/Pair.idl b/udkapi/com/sun/star/beans/Pair.idl
index a55a5c2545d0..6cd1625aec1e 100644
--- a/udkapi/com/sun/star/beans/Pair.idl
+++ b/udkapi/com/sun/star/beans/Pair.idl
@@ -20,29 +20,35 @@
*************************************************************/
-
#ifndef __com_sun_star_beans_Pair_idl__
#define __com_sun_star_beans_Pair_idl__
+
+//=============================================================================
+
module com { module sun { module star { module beans {
//=============================================================================
+
/** A tuple, or pair.
- <p>
- This structure allows for conveniently packing together two values of
- any type, and could be useful as the result type of methods.
- </p>
+ <p> This structure allows for conveniently packing together two values of
+ any type, and could be useful as the result type of methods.</p>
@since OpenOffice 3.0
*/
-published struct Pair<T, U> {
+published struct Pair<T, U>
+{
+ //-------------------------------------------------------------------------
- /// first object.
+ // first object
T First;
- /// second object.
+ // second object
U Second;
+
+ //-------------------------------------------------------------------------
+
};
//=============================================================================
diff --git a/udkapi/com/sun/star/beans/Property.idl b/udkapi/com/sun/star/beans/Property.idl
index 19e3fc3886b6..7367a656d5ef 100644
--- a/udkapi/com/sun/star/beans/Property.idl
+++ b/udkapi/com/sun/star/beans/Property.idl
@@ -36,7 +36,6 @@ module com { module sun { module star { module beans {
/** This structure describes a property.
-
<dl>There are three types of properties:
<dt>- bound properties</dt>
<dt>- constrained properties</dt>
@@ -45,10 +44,12 @@ module com { module sun { module star { module beans {
*/
published struct Property
{
+ //-------------------------------------------------------------------------
+
/** specifies the name of the property.
- <p>The name is unique within an <type>XPropertySet</type>.
- Upper and lower case are distinguished.</p>
+ <p> The name is unique within an <type>XPropertySet</type>.
+ Upper and lower case are distinguished.</p>
*/
string Name;
@@ -56,19 +57,18 @@ published struct Property
/** contains an implementation-specific handle for the property.
- <p>It may be -1 if the implementation has no handle. You can use
- this handle to get values from the <type>XFastPropertySet</type>.</p>
+ <p> It may be -1 if the implementation has no handle. You can use
+ this handle to get values from the <type>XFastPropertySet</type>.</p>
*/
long Handle;
//-------------------------------------------------------------------------
- /** contains an object that identifies the declared type for
- the property.
+ /** contains an object that identifies the declared type for the property.
- <p>If the property has multiple types or the type is not
- known, <strong>but not an <atom>any</atom></strong>, then
- <const>void</const> must be returned.</p>
+ <p> If the property has multiple types or the type is not
+ known, <strong>but not an <atom>any</atom></strong>, then
+ <const>void</const> must be returned.</p>
*/
type Type;
@@ -79,6 +79,8 @@ published struct Property
*/
short Attributes;
+ //-------------------------------------------------------------------------
+
};
//=============================================================================
diff --git a/udkapi/com/sun/star/beans/StringPair.idl b/udkapi/com/sun/star/beans/StringPair.idl
index 44ad810de365..562bee433c86 100644
--- a/udkapi/com/sun/star/beans/StringPair.idl
+++ b/udkapi/com/sun/star/beans/StringPair.idl
@@ -23,9 +23,10 @@
#ifndef __com_sun_star_beans_StringPair_idl__
#define __com_sun_star_beans_StringPair_idl__
+
//=============================================================================
- module com { module sun { module star { module beans {
+module com { module sun { module star { module beans {
//=============================================================================
@@ -33,6 +34,8 @@
*/
published struct StringPair
{
+ //-------------------------------------------------------------------------
+
/** specifies the first of the two strings.
*/
string First;
@@ -42,6 +45,9 @@ published struct StringPair
/** specifies the second of the two strings.
*/
string Second;
+
+ //-------------------------------------------------------------------------
+
};
//=============================================================================
diff --git a/udkapi/com/sun/star/beans/XExactName.idl b/udkapi/com/sun/star/beans/XExactName.idl
index 2cd139b79633..0870d975c21c 100644
--- a/udkapi/com/sun/star/beans/XExactName.idl
+++ b/udkapi/com/sun/star/beans/XExactName.idl
@@ -38,11 +38,11 @@ module com { module sun { module star { module beans {
an approximate name to an existing name.
<p> One field of application is the conversion of case-insensitive
- names to the existing names. </p>
+ names to the existing names.</p>
- <p>Example: A basic interpreter ignores the case of the names. So
- it must query the <type>XExactName</type> interface and then call
- the method. </p>
+ <p> Example: A basic interpreter ignores the case of the names. So
+ it must query the <type>XExactName</type> interface and then call
+ the method.</p>
@see com::sun::star::beans::XPropertySet
@see com::sun::star::beans::XIntrospectionAccess
@@ -53,13 +53,15 @@ published interface XExactName: com::sun::star::uno::XInterface
//-------------------------------------------------------------------------
/** @returns
- the exact name for a given aprroximate name.
+ the exact name for a given approximate name.
- <p>For example "getExactName" could be returned for "GETEXACTNAME"
- when "GETEXACTNAME" was used by a case insesitive scripting language. </p>
+ <p> For example "getExactName" could be returned for "GETEXACTNAME"
+ when "GETEXACTNAME" was used by a case insensitive scripting language.</p>
*/
string getExactName( [in] string aApproximateName );
+ //-------------------------------------------------------------------------
+
};
//=============================================================================
diff --git a/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl b/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl
index a3891f397400..132c955a0dc9 100644
--- a/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl
+++ b/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl
@@ -59,20 +59,20 @@ module com { module sun { module star { module beans {
<p> Usually an object that implements this interface
also implements <type>XPropertySet</type> and at
- least some of the properties have subproperties. </p>
+ least some of the properties have subproperties.</p>
<p> This interface allows direct access to subsubproperties, ...
up to an arbitrary nesting depth. Often the intermediate
- elements of the hierarchy implement <type>XProperty</type>. </p>
+ elements of the hierarchy implement <type>XProperty</type>.</p>
<p> Each implementation specifies how the
hierarchical property names, that are
used to access the elements of the hierarchy,
- are formed. </p>
+ are formed.</p>
<p> Commonly a notation similar to filesystem paths
(separated by '/' slashes) or nested module names
- (separated by dots '.' or '::') is used. </p>
+ (separated by dots '.' or '::') is used.</p>
*/
published interface XHierarchicalPropertySet: com::sun::star::uno::XInterface
@@ -82,14 +82,14 @@ published interface XHierarchicalPropertySet: com::sun::star::uno::XInterface
/** retrieve information about the hierarchy of properties
@returns
- the <type>XHierarchicalPropertySetInfo</type> interface,
- which describes the property hierarchy of the object which
- supplies this interface.
+ the <type>XHierarchicalPropertySetInfo</type> interface,
+ which describes the property hierarchy of the object which
+ supplies this interface.
@returns
- <NULL/> if the implementation cannot or will
- not provide information about the properties; otherwise the
- interface <type>XHierarchicalPropertySetInfo</type> is returned.
+ <NULL/> if the implementation cannot or will
+ not provide information about the properties; otherwise the
+ interface <type>XHierarchicalPropertySetInfo</type> is returned.
*/
com::sun::star::beans::XHierarchicalPropertySetInfo
getHierarchicalPropertySetInfo();
@@ -133,7 +133,9 @@ published interface XHierarchicalPropertySet: com::sun::star::uno::XInterface
//-------------------------------------------------------------------------
- /** @returns
+ /** gets the value of the property with the specified nested name.
+
+ @returns
the value of the property with the specified nested name.
@param aHierarchicalPropertyName
@@ -145,7 +147,7 @@ published interface XHierarchicalPropertySet: com::sun::star::uno::XInterface
@throws com::sun::star::uno::lang::IllegalArgumentException
if <var>aHierarchicalPropertyName</var> is not a well-formed
nested name for this hierarchy.
- An implementation is not required to detect this
+ An implementation is not required to detect this
condition.
@throws com::sun::star::lang::WrappedTargetException
More information about the Libreoffice-commits
mailing list