diff options
author | Michael Stahl <mstahl@redhat.com> | 2013-04-29 18:33:02 +0200 |
---|---|---|
committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:05 +0200 |
commit | b7ba598ced9708da45372a6c3f8e1a17c306be8f (patch) | |
tree | 8f7bef1c06944e35828dfec635abd626ca402cec /udkapi/com/sun/star/beans | |
parent | ae7595a7553c61cab3cc9014bb12239e02fd8c6a (diff) |
*api: clean up multi-line and mal-formed XML tags
It is amazing what some people believe autodoc supports.
Also, com::sun::star::uno::Any does not exist in IDL, that is part of
the C++ language binding.
Change-Id: I1f1f5cf5d27663ace6ff618ecbecb41fd2dfa1fc
Diffstat (limited to 'udkapi/com/sun/star/beans')
-rw-r--r-- | udkapi/com/sun/star/beans/Ambiguous.idl | 5 | ||||
-rw-r--r-- | udkapi/com/sun/star/beans/Defaulted.idl | 5 | ||||
-rw-r--r-- | udkapi/com/sun/star/beans/Introspection.idl | 7 | ||||
-rw-r--r-- | udkapi/com/sun/star/beans/MethodConcept.idl | 7 | ||||
-rw-r--r-- | udkapi/com/sun/star/beans/Optional.idl | 5 | ||||
-rw-r--r-- | udkapi/com/sun/star/beans/TolerantPropertySetResultType.idl | 6 | ||||
-rw-r--r-- | udkapi/com/sun/star/beans/XIntrospection.idl | 4 | ||||
-rw-r--r-- | udkapi/com/sun/star/beans/XIntrospectionAccess.idl | 82 |
8 files changed, 53 insertions, 68 deletions
diff --git a/udkapi/com/sun/star/beans/Ambiguous.idl b/udkapi/com/sun/star/beans/Ambiguous.idl index 2efde9031595..73b063f7c5c5 100644 --- a/udkapi/com/sun/star/beans/Ambiguous.idl +++ b/udkapi/com/sun/star/beans/Ambiguous.idl @@ -25,9 +25,8 @@ module com { module sun { module star { module beans { A value of a given type that can be ambiguous. <p>This structure is used as the type of interface attributes corresponding - to instances of <type scopye="com::sun::star::beans">Property</type> that - have the <const - scope="com::sun::star::beans">PropertyAttribute::MAYBEAMBIGUOUS</const>.</p> + to instances of com::sun::star::beans::Property that + have the com::sun::star::beans::PropertyAttribute::MAYBEAMBIGUOUS.</p> */ struct Ambiguous<T> { /** diff --git a/udkapi/com/sun/star/beans/Defaulted.idl b/udkapi/com/sun/star/beans/Defaulted.idl index b3e5a1ea3504..b7f816e59242 100644 --- a/udkapi/com/sun/star/beans/Defaulted.idl +++ b/udkapi/com/sun/star/beans/Defaulted.idl @@ -25,9 +25,8 @@ module com { module sun { module star { module beans { A value of a given type that can be defaulted. <p>This structure is used as the type of interface attributes corresponding - to instances of <type scopye="com::sun::star::beans">Property</type> that - have the <const - scope="com::sun::star::beans">PropertyAttribute::MAYBEDEFAULT</const>.</p> + to instances of com::sun::star::beans::Property that + have the com::sun::star::beans::PropertyAttribute::MAYBEDEFAULT.</p> */ struct Defaulted<T> { /** diff --git a/udkapi/com/sun/star/beans/Introspection.idl b/udkapi/com/sun/star/beans/Introspection.idl index 706dc27ff082..45b33ce83e84 100644 --- a/udkapi/com/sun/star/beans/Introspection.idl +++ b/udkapi/com/sun/star/beans/Introspection.idl @@ -28,11 +28,10 @@ /** provides functionality to get information about an object's properties and methods. <p><strong>Important note:</strong>An object can only be - inspected completely if it supports the <type scope= - "com::sun::star::lang">XTypeProvider</type> interface.</p> + inspected completely if it supports the + com::sun::star::lang::XTypeProvider interface.</p> - <p>For details see method <member>XIntrospection::inspect - </member>.</p> + <p>For details see method XIntrospection::inspect() .</p> */ published service Introspection : com::sun::star::beans::XIntrospection; diff --git a/udkapi/com/sun/star/beans/MethodConcept.idl b/udkapi/com/sun/star/beans/MethodConcept.idl index 613c87593df4..8d34a054f0da 100644 --- a/udkapi/com/sun/star/beans/MethodConcept.idl +++ b/udkapi/com/sun/star/beans/MethodConcept.idl @@ -67,8 +67,8 @@ published constants MethodConcept <p>These methods have the signature <code>create...Enumeration</code> and return an interface - that is derived from <type scope="com::sun::star::container"> - XEnumeration</type> Additionally, the method + that is derived from com::sun::star::container::XEnumeration. + Additionally, the method com::sun::star::container::XEnumerationAccess::getElementType() belongs to this concept.</p> */ @@ -95,8 +95,7 @@ published constants MethodConcept <code>insert...ByIndex()</code>, <code>replace...ByIndex()</code>, or <code>remove...ByIndex()</code>. - The method <member scope="com::sun::star::container"> - XIndexAccess::getCount()</member> + The method com::sun::star::container::XIndexAccess::getCount() also belongs to this concept. </p> */ const long INDEXCONTAINER = 32; diff --git a/udkapi/com/sun/star/beans/Optional.idl b/udkapi/com/sun/star/beans/Optional.idl index 08974c9fe969..e7ab5f20e4d3 100644 --- a/udkapi/com/sun/star/beans/Optional.idl +++ b/udkapi/com/sun/star/beans/Optional.idl @@ -25,9 +25,8 @@ module com { module sun { module star { module beans { An optional value of a given type. <p>This structure is used as the type of interface attributes corresponding - to instances of <type scopye="com::sun::star::beans">Property</type> that - have the <const - scope="com::sun::star::beans">PropertyAttribute::MAYBEVOID</const>. It might + to instances of com::sun::star::beans::Property that + have the com::sun::star::beans::PropertyAttribute::MAYBEVOID. It might also be useful in other situations, for example as the return type of an interface method.</p> */ diff --git a/udkapi/com/sun/star/beans/TolerantPropertySetResultType.idl b/udkapi/com/sun/star/beans/TolerantPropertySetResultType.idl index 950ceecaea75..f5450887f3b2 100644 --- a/udkapi/com/sun/star/beans/TolerantPropertySetResultType.idl +++ b/udkapi/com/sun/star/beans/TolerantPropertySetResultType.idl @@ -42,7 +42,7 @@ constants TolerantPropertySetResultType /** the property is not available. <p>For example if a - <type scope="com::sun::star::beans" >UnknownPropertyException</type> + com::sun::star::beans::UnknownPropertyException was catched.</p> */ const short UNKNOWN_PROPERTY = 1; @@ -50,7 +50,7 @@ constants TolerantPropertySetResultType /** the value used with the property is not valid. <p>For example if a - <type scope="com::sun::star::lang" >IllegalArgumentException</type> + com::sun::star::lang::IllegalArgumentException was catched.</p> */ const short ILLEGAL_ARGUMENT = 2; @@ -58,7 +58,7 @@ constants TolerantPropertySetResultType /** the property could not be changed at that time. <p>For example if a - <type scope="com::sun::star::beans" >PropertyVetoException</type> + com::sun::star::beans::PropertyVetoException was catched.</p> */ const short PROPERTY_VETO = 3; diff --git a/udkapi/com/sun/star/beans/XIntrospection.idl b/udkapi/com/sun/star/beans/XIntrospection.idl index ca19c2785e4f..9fdb736fc66c 100644 --- a/udkapi/com/sun/star/beans/XIntrospection.idl +++ b/udkapi/com/sun/star/beans/XIntrospection.idl @@ -30,8 +30,8 @@ /** allows the inspection of an object's properties and methods. <p><strong>Important note:</strong>An object can only be - inspected completely if it supports the <type scope= - "com::sun::star::lang">XTypeProvider</type> interface.</p> + inspected completely if it supports the com::sun::star::lang::XTypeProvider + interface.</p> <p>For details see method XIntrospection::inspect(). </p> diff --git a/udkapi/com/sun/star/beans/XIntrospectionAccess.idl b/udkapi/com/sun/star/beans/XIntrospectionAccess.idl index 3e1f8fef2c5c..be325005f117 100644 --- a/udkapi/com/sun/star/beans/XIntrospectionAccess.idl +++ b/udkapi/com/sun/star/beans/XIntrospectionAccess.idl @@ -38,21 +38,19 @@ /** represents the result of an introspection operation done by - the inspect method of <type scope="com::sun::star::beans"> - XIntrospection</type>. + the inspect method of XIntrospection. <p>This interface gives information about an object's properties and methods as detected in the introspection process. It's not possible to access properties or call methods directly using this interface but it provides access to other interfaces to do so. - See <member scope="com::sun::star::beans"> - XIntrospectionAccess::queryAdapter()</member></p> + See com::sun::star::beans::XIntrospectionAccess::queryAdapter()</p> <p>The XExactName interface has to be supported in order to implement inaccurate name access for all objects - which implement the <type scope="com::sun::star::container"> - XNameAccess</type> interface or XPropertySet.</p> + which implement the com::sun::star::container::XNameAccess interface + or XPropertySet.</p> <p>The XMaterialHolder interface has to be supported to give access to the inspected object.</p> @@ -114,22 +112,20 @@ published interface XIntrospectionAccess: com::sun::star::uno::XInterface the name of the property. @param nPropertyConcepts - zero or more constants of the <type>PropertyConcept - </type> constants group combined by an arithmetical + zero or more constants of the PropertyConcept + constants group combined by an arithmetical or-operation. @throws NoSuchElementException when a property with the demanded name doesn't exist - or if it accords to a wrong <type>PropertyConcept - </type>. + or if it accords to a wrong PropertyConcept. */ com::sun::star::beans::Property getProperty( [in] string aName, [in] long nPropertyConcepts ) raises( com::sun::star::container::NoSuchElementException ); /** allows to ask if a property with the demanded name exists - and if it accords to one of the demanded <type> - PropertyConcept</type>s. + and if it accords to one of the demanded PropertyConcept. @returns `TRUE` if the property exists and accords to one of @@ -140,8 +136,8 @@ published interface XIntrospectionAccess: com::sun::star::uno::XInterface the name of the property. @param nPropertyConcepts - zero or more constants of the <type>PropertyConcept - </type> constants group combined by an arithmetical + zero or more constants of the PropertyConcept + constants group combined by an arithmetical or-operation. */ boolean hasProperty( [in] string aName, @@ -154,8 +150,8 @@ published interface XIntrospectionAccess: com::sun::star::uno::XInterface to the demanded PropertyConcepts. @param nPropertyConcepts - zero or more constants of the <type>PropertyConcept - </type> constants group combined by an arithmetical + zero or more constants of the PropertyConcept + constants group combined by an arithmetical or-operation. */ sequence<com::sun::star::beans::Property> getProperties( @@ -164,12 +160,11 @@ published interface XIntrospectionAccess: com::sun::star::uno::XInterface /** returns information about a method if a method with the demanded name exists and if it accords to one of the demanded MethodConcepts. The information is - provided as <type scope="com::sun::star::reflection"> - XIdlMethod</type>. + provided as com::sun::star::reflection::XIdlMethod. @returns - A <type scope="com::sun::star::reflection"> - XIdlMethod</type> providing information about and + A com::sun::star::reflection::XIdlMethod providing + information about and access to the demanded method if a corresponding method exists. @@ -177,8 +172,8 @@ published interface XIntrospectionAccess: com::sun::star::uno::XInterface the name of the method. @param nMethodConcepts - zero or more constants of the <type>MethodConcept - </type> constants group combined by an arithmetical + zero or more constants of the MethodConcept + constants group combined by an arithmetical or-operation. @throws NoSuchElementException @@ -190,8 +185,7 @@ published interface XIntrospectionAccess: com::sun::star::uno::XInterface raises( com::sun::star::lang::NoSuchMethodException ); /** allows to ask if a method with the demanded name exists - and if it accords to one of the demanded <type>MethodConcept - </type>s. + and if it accords to one of the demanded MethodConcept. @returns `TRUE` if the method exists and accords to one of @@ -202,8 +196,8 @@ published interface XIntrospectionAccess: com::sun::star::uno::XInterface the name of the method. @param nMethodConcepts - zero or more constants of the <type>MethodConcept - </type> constants group combined by an arithmetical + zero or more constants of the MethodConcept + constants group combined by an arithmetical or-operation. */ boolean hasMethod( [in] string aName, @@ -216,8 +210,8 @@ published interface XIntrospectionAccess: com::sun::star::uno::XInterface to the demanded MethodConcepts. @param nMethodConcepts - zero or more constants of the <type>MethodConcept - </type> constants group combined by an arithmetical + zero or more constants of the MethodConcept + constants group combined by an arithmetical or-operation. */ sequence<com::sun::star::reflection::XIdlMethod> getMethods( @@ -241,36 +235,32 @@ published interface XIntrospectionAccess: com::sun::star::uno::XInterface /** creates an adapter that implements an interface with the specified type. - <p>To access properties, query for the <type>XPropertySet - </type> interface. If the XPropertySet can + <p>To access properties, query for the XPropertySet + interface. If the XPropertySet can be queried, the XFastPropertySet interface must be supported too. </p> <p>If the introspected object implements a name container, - the introspection should return the <type scope= - "com::sun::star::container">XNameAccess</type> and <type - scope="com::sun::star::container">XNameContainer</type> - interfaces.</p> + the introspection should return the + com::sun::star::container::XNameAccess and + com::sun::star::container::XNameContainer interfaces.</p> <p>If the introspected object implements an index container, - the introspection should return the <type scope= - "com::sun::star::container">XIndexAccess</type> and <type - scope="com::sun::star::container">XIndexContainer</type> - interfaces.</p> + the introspection should return the + com::sun::star::container::XIndexAccess and + com::sun::star::container::XIndexContainer interfaces.</p> <p>If the introspected object implements an enumeration - container, the introspection should return the <type scope= - "com::sun::star::container">XEnumerationAccess</type> - interface.</p> + container, the introspection should return the + com::sun::star::container::XEnumerationAccess interface.</p> - <p>If the introspected object implements the <type scope= - "com::sun::star::reflection">XIdlArray</type> interface, + <p>If the introspected object implements the + com::sun::star::reflection::XIdlArray interface, the introspection should return this.</p> <p>To implement inaccurate name access, at all objects, - which implement the <type scope="com::sun::star::container"> - XNameAccess</type> or XPropertySet interface, - the XExactName interface has to be supported. + which implement the com::sun::star::container::XNameAccess or + XPropertySet interface, the XExactName interface has to be supported. </p> @see com::sun::star::beans::XExactName |