summaryrefslogtreecommitdiff
path: root/udkapi
diff options
context:
space:
mode:
authorMichael Stahl <mstahl@redhat.com>2013-05-01 00:26:55 +0200
committerMichael Stahl <mstahl@redhat.com>2013-06-04 12:01:08 +0200
commit392706b5f743b2f989ba5a120bbb31c2296bf902 (patch)
tree6d37555b819fb1c482106f29c0aede2a121ae819 /udkapi
parented993aafc928717ead4fae6b6dac8845771d8661 (diff)
*api: fix loads of badly documented parameters
Change-Id: Ifcfdcc1aee5f45745ab17d83f69c2cf293b58196
Diffstat (limited to 'udkapi')
-rw-r--r--udkapi/com/sun/star/beans/XMultiHierarchicalPropertySet.idl6
-rw-r--r--udkapi/com/sun/star/beans/XMultiPropertySet.idl13
-rw-r--r--udkapi/com/sun/star/beans/XMultiPropertyStates.idl8
-rw-r--r--udkapi/com/sun/star/beans/XPropertyContainer.idl4
-rw-r--r--udkapi/com/sun/star/beans/XPropertySetInfo.idl6
-rw-r--r--udkapi/com/sun/star/beans/XPropertyState.idl11
-rw-r--r--udkapi/com/sun/star/beans/XTolerantMultiPropertySet.idl2
-rw-r--r--udkapi/com/sun/star/container/XIdentifierAccess.idl2
-rw-r--r--udkapi/com/sun/star/lang/XConnectionPoint.idl2
-rw-r--r--udkapi/com/sun/star/registry/XRegistryKey.idl16
-rw-r--r--udkapi/com/sun/star/registry/XSimpleRegistry.idl4
-rw-r--r--udkapi/com/sun/star/script/XDebugging.idl2
-rw-r--r--udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl4
-rw-r--r--udkapi/com/sun/star/script/XLibraryAccess.idl2
-rw-r--r--udkapi/com/sun/star/uno/XAggregation.idl8
-rw-r--r--udkapi/com/sun/star/uri/XUriSchemeParser.idl2
16 files changed, 47 insertions, 45 deletions
diff --git a/udkapi/com/sun/star/beans/XMultiHierarchicalPropertySet.idl b/udkapi/com/sun/star/beans/XMultiHierarchicalPropertySet.idl
index 2c4a7502328a..e2fbf62d9a43 100644
--- a/udkapi/com/sun/star/beans/XMultiHierarchicalPropertySet.idl
+++ b/udkapi/com/sun/star/beans/XMultiHierarchicalPropertySet.idl
@@ -66,10 +66,10 @@ published interface XMultiHierarchicalPropertySet: com::sun::star::uno::XInterfa
<p> Unknown properties are ignored. </p>
- @param aHierarchicalPropertyNames
+ @param HierarchicalPropertyNames
This parameter specifies the names of the properties.
- @param aValues
+ @param Values
This parameter specifies the new values for the properties.
@throws PropertyVetoException
@@ -93,7 +93,7 @@ published interface XMultiHierarchicalPropertySet: com::sun::star::uno::XInterfa
*/
- void setHierarchicalPropertyValues( [in] sequence<string> aHierarchicalPropertyNames,
+ void setHierarchicalPropertyValues( [in] sequence<string> HierarchicalPropertyNames,
[in] sequence<any> Values )
raises( com::sun::star::beans::PropertyVetoException,
com::sun::star::lang::IllegalArgumentException,
diff --git a/udkapi/com/sun/star/beans/XMultiPropertySet.idl b/udkapi/com/sun/star/beans/XMultiPropertySet.idl
index 5c7adce43357..409be2bfbbfe 100644
--- a/udkapi/com/sun/star/beans/XMultiPropertySet.idl
+++ b/udkapi/com/sun/star/beans/XMultiPropertySet.idl
@@ -123,25 +123,26 @@ published interface XMultiPropertySet: com::sun::star::uno::XInterface
<p>It is suggested to allow multiple registration of the same listener,
thus for each time a listener is added, it has to be removed.
- @param
+ @param Listener
contains the listener to be removed.
@see addPropertiesChangeListener
*/
- void removePropertiesChangeListener( [in] com::sun::star::beans::XPropertiesChangeListener xListener );
+ void removePropertiesChangeListener(
+ [in] com::sun::star::beans::XPropertiesChangeListener Listener );
/** fires a sequence of PropertyChangeEvents to the specified
listener.
- @param aPropertynames
+ @param PropertyNames
specifies the sorted names of the properties.
- @param xListener
+ @param Listener
contains the listener for the property change events.
*/
- void firePropertiesChangeEvent( [in] sequence<string> aPropertyNames,
- [in] com::sun::star::beans::XPropertiesChangeListener xListener );
+ void firePropertiesChangeEvent( [in] sequence<string> PropertyNames,
+ [in] com::sun::star::beans::XPropertiesChangeListener Listener );
};
diff --git a/udkapi/com/sun/star/beans/XMultiPropertyStates.idl b/udkapi/com/sun/star/beans/XMultiPropertyStates.idl
index a54945b43fbd..4e970ad4d4ee 100644
--- a/udkapi/com/sun/star/beans/XMultiPropertyStates.idl
+++ b/udkapi/com/sun/star/beans/XMultiPropertyStates.idl
@@ -70,14 +70,14 @@ published interface XMultiPropertyStates: com::sun::star::uno::XInterface
the change events are fired. If it is a constrained property, you
must fire the vetoable event before you change the property value. </p>
- @param aPropertyName
+ @param PropertyNames
specifies the names of the properties. All names must be unique.
This sequence must be alphabetically sorted.
@throws UnknownPropertyException
if one of the properties does not exist.
*/
- void setPropertiesToDefault( [in] sequence<string> aPropertyNames )
+ void setPropertiesToDefault( [in] sequence<string> PropertyNames )
raises( com::sun::star::beans::UnknownPropertyException );
/** @returns
@@ -87,7 +87,7 @@ published interface XMultiPropertyStates: com::sun::star::uno::XInterface
then the return type at the corresponding position in the
sequence returned is `void`. </p>
- @param aPropertyName
+ @param PropertyNames
specifies the names of the properties. All names must be unique.
This sequence must be alphabetically sorted.
@@ -100,7 +100,7 @@ published interface XMultiPropertyStates: com::sun::star::uno::XInterface
com::sun::star::lang::WrappedTargetException.
*/
sequence<any> getPropertyDefaults(
- [in] sequence<string> aPropertyNames )
+ [in] sequence<string> PropertyNames )
raises( com::sun::star::beans::UnknownPropertyException,
com::sun::star::lang::WrappedTargetException );
};
diff --git a/udkapi/com/sun/star/beans/XPropertyContainer.idl b/udkapi/com/sun/star/beans/XPropertyContainer.idl
index 72f1876e55e1..1843082b27e7 100644
--- a/udkapi/com/sun/star/beans/XPropertyContainer.idl
+++ b/udkapi/com/sun/star/beans/XPropertyContainer.idl
@@ -48,7 +48,7 @@ published interface XPropertyContainer: com::sun::star::uno::XInterface
/** adds a property to the object.
- @param aName
+ @param Name
specifies the name of the new property.
@param Attributes
@@ -74,7 +74,7 @@ published interface XPropertyContainer: com::sun::star::uno::XInterface
/** removes a property from the object.
- @param aName
+ @param Name
specified the name of the property.
@throws UnknownPropertyException
diff --git a/udkapi/com/sun/star/beans/XPropertySetInfo.idl b/udkapi/com/sun/star/beans/XPropertySetInfo.idl
index 938eb5e55012..7e3f37e3eda3 100644
--- a/udkapi/com/sun/star/beans/XPropertySetInfo.idl
+++ b/udkapi/com/sun/star/beans/XPropertySetInfo.idl
@@ -55,13 +55,13 @@ published interface XPropertySetInfo: com::sun::star::uno::XInterface
/** @returns
the property with the specified name from the object.
- @param aName
+ @param Name
specifies the name of the property.
@throws UnknownPropertyException
if the property does not exist.
*/
- com::sun::star::beans::Property getPropertyByName( [in] string aName )
+ com::sun::star::beans::Property getPropertyByName( [in] string Name )
raises( com::sun::star::beans::UnknownPropertyException );
@@ -69,7 +69,7 @@ published interface XPropertySetInfo: com::sun::star::uno::XInterface
`TRUE` if a property with the specified name exist;
otherwise `FALSE` is returned.
- @param aName
+ @param Name
specifies the name of the property.
*/
boolean hasPropertyByName( [in] string Name );
diff --git a/udkapi/com/sun/star/beans/XPropertyState.idl b/udkapi/com/sun/star/beans/XPropertyState.idl
index e844cfc0b923..68f8d527c880 100644
--- a/udkapi/com/sun/star/beans/XPropertyState.idl
+++ b/udkapi/com/sun/star/beans/XPropertyState.idl
@@ -51,13 +51,14 @@ published interface XPropertyState: com::sun::star::uno::XInterface
/** @returns
the state of the property.
- @param aPropertyName
+ @param PropertyName
specifies the name of the property.
@throws UnknownPropertyException
if the property does not exist.
*/
- com::sun::star::beans::PropertyState getPropertyState( [in] string PropertyName )
+ com::sun::star::beans::PropertyState getPropertyState(
+ [in] string PropertyName )
raises( com::sun::star::beans::UnknownPropertyException );
@@ -68,14 +69,14 @@ published interface XPropertyState: com::sun::star::uno::XInterface
<p>The order of the states is correlating to the order of the
given property names. </p>
- @param aPropertyNames
+ @param PropertyNames
contains the sequence of property names.
@throws UnknownPropertyException
if one property does not exist.
*/
sequence<com::sun::star::beans::PropertyState> getPropertyStates(
- [in] sequence<string> aPropertyName )
+ [in] sequence<string> PropertyNames )
raises( com::sun::star::beans::UnknownPropertyException );
@@ -87,7 +88,7 @@ published interface XPropertyState: com::sun::star::uno::XInterface
must fire the vetoable event before you change the property value.
</p>
- @param aPropertyname
+ @param PropertyName
specifies the name of the property.
@throws UnknownPropertyException
diff --git a/udkapi/com/sun/star/beans/XTolerantMultiPropertySet.idl b/udkapi/com/sun/star/beans/XTolerantMultiPropertySet.idl
index 6e20545d9371..a003c14b4883 100644
--- a/udkapi/com/sun/star/beans/XTolerantMultiPropertySet.idl
+++ b/udkapi/com/sun/star/beans/XTolerantMultiPropertySet.idl
@@ -57,7 +57,7 @@ published interface XTolerantMultiPropertySet : com::sun::star::uno::XInterface
<p>If the names are not sorted the behaviour of the method
is undefined!</p>
- @param aPropertyValues
+ @param aValues
specifies the values of the properties.
The order of the values has to be the same as in the
<var>aPropertyNames</var> parameter int order to match
diff --git a/udkapi/com/sun/star/container/XIdentifierAccess.idl b/udkapi/com/sun/star/container/XIdentifierAccess.idl
index aa527be3682b..0711ed6defb5 100644
--- a/udkapi/com/sun/star/container/XIdentifierAccess.idl
+++ b/udkapi/com/sun/star/container/XIdentifierAccess.idl
@@ -47,7 +47,7 @@ published interface XIdentifierAccess: com::sun::star::container::XElementAccess
then wrap these in a com::sun::star::lang::WrappedTargetException
exception.
*/
- any getByIdentifier( [in] long Identifierr )
+ any getByIdentifier( [in] long Identifier )
raises( com::sun::star::container::NoSuchElementException,
com::sun::star::lang::WrappedTargetException );
diff --git a/udkapi/com/sun/star/lang/XConnectionPoint.idl b/udkapi/com/sun/star/lang/XConnectionPoint.idl
index b76bf5c75418..2177207b14d9 100644
--- a/udkapi/com/sun/star/lang/XConnectionPoint.idl
+++ b/udkapi/com/sun/star/lang/XConnectionPoint.idl
@@ -144,7 +144,7 @@ published interface XConnectionPoint: com::sun::star::uno::XInterface
We ignore the problem in this interface. A solution must be
provided in an additional XConnectionPoint interface. </p>
- @param listener
+ @param xListener
specifies the listener interface on the client's advise sink.
@see com::sun::star::beans::XPropertySet::removePropertyChangeListener
diff --git a/udkapi/com/sun/star/registry/XRegistryKey.idl b/udkapi/com/sun/star/registry/XRegistryKey.idl
index d2759d9e3112..c39357c54b6b 100644
--- a/udkapi/com/sun/star/registry/XRegistryKey.idl
+++ b/udkapi/com/sun/star/registry/XRegistryKey.idl
@@ -303,7 +303,7 @@ published interface XRegistryKey: com::sun::star::uno::XInterface
/** deletes a key from the registry.
- @param aKeyName
+ @param KeyName
specifies the relative path from the current key to
the key which will be deleted.
@@ -311,7 +311,7 @@ published interface XRegistryKey: com::sun::star::uno::XInterface
if the registry is not open, the registry is readonly,
the key does not exists or if the key is of type LINK.
*/
- void deleteKey( [in] string rKeyName )
+ void deleteKey( [in] string KeyName )
raises( com::sun::star::registry::InvalidRegistryException );
// DOCUMENTATION CHANGED FOR XRegistryKey::openKeys
@@ -364,7 +364,7 @@ published interface XRegistryKey: com::sun::star::uno::XInterface
/** deletes a link from the registry.
- @param aLinkName
+ @param LinkName
specifies the relative path from the current key to
the link which will be deleted.
@@ -372,21 +372,21 @@ published interface XRegistryKey: com::sun::star::uno::XInterface
if the registry is not open, the registry is readonly,
or if the link does not exist.
*/
- void deleteLink( [in] string rLinkName )
+ void deleteLink( [in] string LinkName )
raises( com::sun::star::registry::InvalidRegistryException );
// DOCUMENTATION CHANGED FOR XRegistryKey::getLinkTarget
/** @returns
the target (complete path of a key) of the link specified by rLinkName.
- @param rLinKName
+ @param LinkName
specifies the relative path from the current key to
the link which target will be returned.
@throws InvalidRegistryException
if the registry is not open or the link does not exists.
*/
- string getLinkTarget( [in] string rLinkName )
+ string getLinkTarget( [in] string LinkName )
raises( com::sun::star::registry::InvalidRegistryException );
// DOCUMENTATION CHANGED FOR XRegistryKey::getResolvedName
@@ -395,13 +395,13 @@ published interface XRegistryKey: com::sun::star::uno::XInterface
If a link could not be resolved, the linktarget concatenated with the unresolved rest
of the name, will be returned.
- @param rKeyName
+ @param KeyName
specifies a relative path from the current key which will be resolved from all links.
@throws InvalidRegistryException
if the registry is not open or a recursion was detected.
*/
- string getResolvedName( [in] string aKeyName )
+ string getResolvedName( [in] string KeyName )
raises( com::sun::star::registry::InvalidRegistryException );
};
diff --git a/udkapi/com/sun/star/registry/XSimpleRegistry.idl b/udkapi/com/sun/star/registry/XSimpleRegistry.idl
index 5cf60eed4eca..544170a78dd9 100644
--- a/udkapi/com/sun/star/registry/XSimpleRegistry.idl
+++ b/udkapi/com/sun/star/registry/XSimpleRegistry.idl
@@ -46,7 +46,7 @@ published interface XSimpleRegistry: com::sun::star::uno::XInterface
<p>If a local registry is already open, this function
will close the currently open registry.
- @param aURL
+ @param URL
specifies the complete URL to access the data source.
@param bReadOnly
@@ -60,7 +60,7 @@ published interface XSimpleRegistry: com::sun::star::uno::XInterface
@throws InvalidRegistryException
if the registry does not exist.
*/
- void open( [in] string rURL,
+ void open( [in] string URL,
[in] boolean bReadOnly,
[in] boolean bCreate )
raises( com::sun::star::registry::InvalidRegistryException );
diff --git a/udkapi/com/sun/star/script/XDebugging.idl b/udkapi/com/sun/star/script/XDebugging.idl
index 5ca01942158a..a220b7c321a3 100644
--- a/udkapi/com/sun/star/script/XDebugging.idl
+++ b/udkapi/com/sun/star/script/XDebugging.idl
@@ -56,7 +56,7 @@ published interface XDebugging: com::sun::star::uno::XInterface
in the call stack, 1 the next and so on.
*/
string eval( [in] string aSourceCode,
- [in] short nCallStackPos );
+ [in] short CallStackPos );
/** Returns the engine's stack trace of the current execute position. Line break is the delimiter.
*/
diff --git a/udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl b/udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl
index 2cc20bdbe3c8..be271da7d438 100644
--- a/udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl
+++ b/udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl
@@ -37,7 +37,7 @@ published interface XInvocationAdapterFactory2 : com::sun::star::uno::XInterface
@param Invocation
invocation interface being called on incoming adapter calls
- @param aType
+ @param Types
supported types of adapter
@returns
@@ -46,7 +46,7 @@ published interface XInvocationAdapterFactory2 : com::sun::star::uno::XInterface
*/
com::sun::star::uno::XInterface createAdapter(
[in] XInvocation Invocation,
- [in] sequence< type > aTypes );
+ [in] sequence< type > Types );
};
}; }; }; };
diff --git a/udkapi/com/sun/star/script/XLibraryAccess.idl b/udkapi/com/sun/star/script/XLibraryAccess.idl
index 95cc85dc54c3..f00704293d9e 100644
--- a/udkapi/com/sun/star/script/XLibraryAccess.idl
+++ b/udkapi/com/sun/star/script/XLibraryAccess.idl
@@ -66,7 +66,7 @@ published interface XLibraryAccess: com::sun::star::uno::XInterface
@return an empty sequence, if this module is not found or the
code is not compiled.
*/
- sequence<byte> getModuleCode( [in] string aModuleName );
+ sequence<byte> getModuleCode( [in] string ModuleName );
/** get the source code of a function.
*/
diff --git a/udkapi/com/sun/star/uno/XAggregation.idl b/udkapi/com/sun/star/uno/XAggregation.idl
index 04e77ceb8477..c023f68ee61d 100644
--- a/udkapi/com/sun/star/uno/XAggregation.idl
+++ b/udkapi/com/sun/star/uno/XAggregation.idl
@@ -70,9 +70,9 @@ published interface XAggregation: com::sun::star::uno::XInterface
{
/** sets the object to which all calls to the method
XInterface::queryInterface()
- have to be forwarded. @
+ have to be forwarded.
- @param xDelegator
+ @param Delegator
specifies the object which handles the calls to
XInterface::queryInterface().
If <var>xDelegator</var> is NULL, the delegator is
@@ -83,11 +83,11 @@ published interface XAggregation: com::sun::star::uno::XInterface
@see XAggregation::queryAggregation
*/
- void setDelegator( [in] com::sun::star::uno::XInterface pDelegator );
+ void setDelegator( [in] com::sun::star::uno::XInterface Delegator );
/** is similar to XInterface::queryInterface(),
but it is to be processed directly without being forwarded to the
- delegator. @
+ delegator.
<p>This method is only called from within an implementation of
XInterface::queryInterface()
diff --git a/udkapi/com/sun/star/uri/XUriSchemeParser.idl b/udkapi/com/sun/star/uri/XUriSchemeParser.idl
index 0794ba803f80..e07aec8e4c7a 100644
--- a/udkapi/com/sun/star/uri/XUriSchemeParser.idl
+++ b/udkapi/com/sun/star/uri/XUriSchemeParser.idl
@@ -50,7 +50,7 @@ published interface XUriSchemeParser: com::sun::star::uno::XInterface {
the textual representation of the scheme part (without the delimiting
&ldquo;<code>:</code>&rdquo;).
- @param uriReference
+ @param schemeSpecificPart
the textual representation of the scheme-specific part.
@returns