diff options
author | Michael Stahl <mstahl@redhat.com> | 2013-04-27 21:47:17 +0200 |
---|---|---|
committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:00:59 +0200 |
commit | 944eb9902788d8afec9e3f0f65d3b680041e039b (patch) | |
tree | 3bbb926890561b81d9f6ae611be4677876799a36 /offapi/com/sun/star/xml | |
parent | include: convert <type> here too (diff) | |
download | core-944eb9902788d8afec9e3f0f65d3b680041e039b.tar.gz core-944eb9902788d8afec9e3f0f65d3b680041e039b.zip |
*api: convert <type>Foo</type>
Doxygen does not know type element and will recognize strings that
contain capital letter (all API types do) automatically as type.
This patch removes 15k doxygen warnings.
git ls-files | grep \\.idl | xargs sed -i "s,<type>\([^<]\+\)</type>,\1,"
Change-Id: I45c07cf0b115d5fb5353f4aa9719839615ea1150
Diffstat (limited to 'offapi/com/sun/star/xml')
18 files changed, 64 insertions, 64 deletions
diff --git a/offapi/com/sun/star/xml/ParaUserDefinedAttributesSupplier.idl b/offapi/com/sun/star/xml/ParaUserDefinedAttributesSupplier.idl index da542eded283..27978f358454 100644 --- a/offapi/com/sun/star/xml/ParaUserDefinedAttributesSupplier.idl +++ b/offapi/com/sun/star/xml/ParaUserDefinedAttributesSupplier.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module xml { */ published service ParaUserDefinedAttributesSupplier { - /** This container holds the <type>AttributeData</type> elements + /** This container holds the AttributeData elements that represent uninterpreted XML attributes of a paragraph. <p>The idea behind this property is that a parser can stow @@ -41,7 +41,7 @@ published service ParaUserDefinedAttributesSupplier <p>The <type scope="com::sun::star::container">XNameContainer</type> - supports the service <type>AttributeContainer</type>.</p> + supports the service AttributeContainer.</p> */ [property] ::com::sun::star::container::XNameContainer ParaUserDefinedAttributes; diff --git a/offapi/com/sun/star/xml/TextUserDefinedAttributesSupplier.idl b/offapi/com/sun/star/xml/TextUserDefinedAttributesSupplier.idl index 8d595f79c9ab..2e4ed958b7f0 100644 --- a/offapi/com/sun/star/xml/TextUserDefinedAttributesSupplier.idl +++ b/offapi/com/sun/star/xml/TextUserDefinedAttributesSupplier.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module xml { */ published service TextUserDefinedAttributesSupplier { - /** This container holds the <type>AttributeData</type> elements + /** This container holds the AttributeData elements that represent uninterpreted XML attributes of a text. <p>The idea behind this property is that a parser can stow @@ -41,7 +41,7 @@ published service TextUserDefinedAttributesSupplier <p>The <type scope="com::sun::star::container">XNameContainer</type> - supports the service <type>AttributeContainer</type>.</p> + supports the service AttributeContainer.</p> */ [property] ::com::sun::star::container::XNameContainer TextUserDefinedAttributes; diff --git a/offapi/com/sun/star/xml/UserDefinedAttributesSupplier.idl b/offapi/com/sun/star/xml/UserDefinedAttributesSupplier.idl index 86319c05ec34..ae35cd4b9b8b 100644 --- a/offapi/com/sun/star/xml/UserDefinedAttributesSupplier.idl +++ b/offapi/com/sun/star/xml/UserDefinedAttributesSupplier.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module xml { */ published service UserDefinedAttributesSupplier { - /** This container holds the <type>AttributeData</type> elements + /** This container holds the AttributeData elements that represent uninterpreted XML attributes. <p>The idea behind this property is that a parser can stow @@ -41,7 +41,7 @@ published service UserDefinedAttributesSupplier <p>The <type scope="com::sun::star::container">XNameContainer</type> - supports the service <type>AttributeContainer</type>.</p> + supports the service AttributeContainer.</p> */ [property] ::com::sun::star::container::XNameContainer UserDefinedAttributes; diff --git a/offapi/com/sun/star/xml/crypto/CipherID.idl b/offapi/com/sun/star/xml/crypto/CipherID.idl index d066ca15d019..9e34c09f6e84 100644 --- a/offapi/com/sun/star/xml/crypto/CipherID.idl +++ b/offapi/com/sun/star/xml/crypto/CipherID.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module xml { module crypto { /** The constant set contains identifiers of supported cipher-creation algorithms. - @see <type>XCipherContextSupplier</type> + @see XCipherContextSupplier @since OOo 3.4 */ constants CipherID diff --git a/offapi/com/sun/star/xml/crypto/DigestID.idl b/offapi/com/sun/star/xml/crypto/DigestID.idl index 83822d88148b..b913ef19ec3b 100644 --- a/offapi/com/sun/star/xml/crypto/DigestID.idl +++ b/offapi/com/sun/star/xml/crypto/DigestID.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module xml { module crypto { /** The constant set contains identifiers of supported digest-creation algorithms. - @see <type>XDigestContextSupplier</type> + @see XDigestContextSupplier @since OOo 3.4 */ constants DigestID diff --git a/offapi/com/sun/star/xml/crypto/XCipherContext.idl b/offapi/com/sun/star/xml/crypto/XCipherContext.idl index 873d3067adc0..bae91c7b139d 100644 --- a/offapi/com/sun/star/xml/crypto/XCipherContext.idl +++ b/offapi/com/sun/star/xml/crypto/XCipherContext.idl @@ -31,7 +31,7 @@ The algorithm as well as encryption data are specified on object creation. </p> - @see <type>XCipherContextSupplier</type> + @see XCipherContextSupplier @since OOo 3.4 */ interface XCipherContext : com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/xml/crypto/XCipherContextSupplier.idl b/offapi/com/sun/star/xml/crypto/XCipherContextSupplier.idl index 0a13cf87e60d..1fd2d5065c3d 100644 --- a/offapi/com/sun/star/xml/crypto/XCipherContextSupplier.idl +++ b/offapi/com/sun/star/xml/crypto/XCipherContextSupplier.idl @@ -38,7 +38,7 @@ interface XCipherContextSupplier : com::sun::star::uno::XInterface @param nCipherID the internal ID specifying the algorithm, - should take value from <type>CipherID</type> + should take value from CipherID @param aKey the key that should be used for the encryption diff --git a/offapi/com/sun/star/xml/crypto/XDigestContext.idl b/offapi/com/sun/star/xml/crypto/XDigestContext.idl index aa869cbe02bb..06553a7da8e9 100644 --- a/offapi/com/sun/star/xml/crypto/XDigestContext.idl +++ b/offapi/com/sun/star/xml/crypto/XDigestContext.idl @@ -30,7 +30,7 @@ The algorithm to generate the digest is specified on object creation. </p> - @see <type>XDigestContextSupplier</type> + @see XDigestContextSupplier @since OOo 3.4 */ interface XDigestContext : com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/xml/crypto/XDigestContextSupplier.idl b/offapi/com/sun/star/xml/crypto/XDigestContextSupplier.idl index 30daeac41ea5..ead3e8ea95a4 100644 --- a/offapi/com/sun/star/xml/crypto/XDigestContextSupplier.idl +++ b/offapi/com/sun/star/xml/crypto/XDigestContextSupplier.idl @@ -38,7 +38,7 @@ interface XDigestContextSupplier : com::sun::star::uno::XInterface @param nDigestID the internal ID specifying the algorithm, - should take value from <type>DigestID</type> + should take value from DigestID @param aParams optional parameters that could be used to initialize the digest, diff --git a/offapi/com/sun/star/xml/sax/XEntityResolver.idl b/offapi/com/sun/star/xml/sax/XEntityResolver.idl index d78c0fec7ced..ad479dc7cfc8 100644 --- a/offapi/com/sun/star/xml/sax/XEntityResolver.idl +++ b/offapi/com/sun/star/xml/sax/XEntityResolver.idl @@ -39,10 +39,10 @@ published interface XEntityResolver: com::sun::star::uno::XInterface { /** @returns - <type>InputSource</type> for the external entity. + InputSource for the external entity. <p>If <var>aInputStream</var> is a valid reference to an input stream, - the parser uses this <type>InputSource</type>. Otherwise the + the parser uses this InputSource. Otherwise the parser seeks for the entity using its default behavior. */ InputSource resolveEntity( [in] string sPublicId, [in] string sSystemId ); diff --git a/offapi/com/sun/star/xml/sax/XErrorHandler.idl b/offapi/com/sun/star/xml/sax/XErrorHandler.idl index da5a1e9ba495..db26a9e76276 100644 --- a/offapi/com/sun/star/xml/sax/XErrorHandler.idl +++ b/offapi/com/sun/star/xml/sax/XErrorHandler.idl @@ -39,7 +39,7 @@ module com { module sun { module star { module xml { module sax { <p>This interface is a slight adaption of the Java interface <code>org.xml.sax.ErrorHandler</code>. In IDL, no exception can be passed as an argument, so an <code>any</code> serves as the container. The type of the - exception is <type>SAXParseException</type> or an instance of a derived class.</p> + exception is SAXParseException or an instance of a derived class.</p> */ published interface XErrorHandler: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl b/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl index fe6f0e510277..2529f30b165e 100644 --- a/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl +++ b/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl @@ -57,7 +57,7 @@ published interface XExtendedDocumentHandler: com::sun::star::xml::sax::XDocumen raises( com::sun::star::xml::sax::SAXException ); /** informs a writer that it is allowable to insert a line break and - indentation before the next <type>XDocumentHandler</type>-call. + indentation before the next XDocumentHandler-call. */ void allowLineBreak() raises( com::sun::star::xml::sax::SAXException ); diff --git a/offapi/com/sun/star/xml/sax/XFastAttributeList.idl b/offapi/com/sun/star/xml/sax/XFastAttributeList.idl index 5821b35eecd7..1437ceaebae1 100644 --- a/offapi/com/sun/star/xml/sax/XFastAttributeList.idl +++ b/offapi/com/sun/star/xml/sax/XFastAttributeList.idl @@ -32,9 +32,9 @@ module com { module sun { module star { module xml { module sax { <br>Attributes are separated into known attributes and unknown attributes. <p>Known attributes have a local name that is known to the <type>XFastTokenHandler</token> - registered at the <type>XFastParser</type> which created the sax event containing + registered at the XFastParser which created the sax event containing this attributes. If an attribute also has a namespace, that must be registered - at the <type>XFastParser</type>, else this attribute is also unknown even if + at the XFastParser, else this attribute is also unknown even if the local name is known. */ interface XFastAttributeList: com::sun::star::uno::XInterface @@ -42,12 +42,12 @@ interface XFastAttributeList: com::sun::star::uno::XInterface /** checks if an attribute is available.<br> @param Token - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>.<br> + contains the integer token from the XFastTokenHandler + registered at the XFastParser.<br> If the attribute name has a namespace that was registered with the - <type>XFastParser</type>, Token contains the integer token of the - attributes local name from the <type>XFastTokenHandler</type> and + XFastParser, Token contains the integer token of the + attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. @@ -59,12 +59,12 @@ interface XFastAttributeList: com::sun::star::uno::XInterface /** retrieves the token of an attributes value.<br> @param Token - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>.<br> + contains the integer token from the XFastTokenHandler + registered at the XFastParser.<br> If the attribute name has a namespace that was registered with the - <type>XFastParser</type>, Token contains the integer token of the - attributes local name from the <type>XFastTokenHandler</type> and + XFastParser, Token contains the integer token of the + attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. @@ -81,12 +81,12 @@ interface XFastAttributeList: com::sun::star::uno::XInterface /**retrieves the token of an attributes value.<br> @param Token - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>.<br> + contains the integer token from the XFastTokenHandler + registered at the XFastParser.<br> If the attribute name has a namespace that was registered with the - <type>XFastParser</type>, Token contains the integer token of the - attributes local name from the <type>XFastTokenHandler</type> and + XFastParser, Token contains the integer token of the + attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. @@ -104,12 +104,12 @@ interface XFastAttributeList: com::sun::star::uno::XInterface /** retrieves the value of an attributes.<br> @param Token - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>.<br> + contains the integer token from the XFastTokenHandler + registered at the XFastParser.<br> If the attribute name has a namespace that was registered with the - <type>XFastParser</type>, Token contains the integer token of the - attributes local name from the <type>XFastTokenHandler</type> and + XFastParser, Token contains the integer token of the + attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. @@ -126,12 +126,12 @@ interface XFastAttributeList: com::sun::star::uno::XInterface /** retrieves the value of an attributes.<br> @param Token - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>.<br> + contains the integer token from the XFastTokenHandler + registered at the XFastParser.<br> If the attribute name has a namespace that was registered with the - <type>XFastParser</type>, Token contains the integer token of the - attributes local name from the <type>XFastTokenHandler</type> and + XFastParser, Token contains the integer token of the + attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. diff --git a/offapi/com/sun/star/xml/sax/XFastContextHandler.idl b/offapi/com/sun/star/xml/sax/XFastContextHandler.idl index 147811c73161..a9996af32195 100644 --- a/offapi/com/sun/star/xml/sax/XFastContextHandler.idl +++ b/offapi/com/sun/star/xml/sax/XFastContextHandler.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module xml { module sax { /** receives notification of sax document events from a - <type>XFastParser</type>. + XFastParser. @see XFastDocumentHandler */ @@ -43,17 +43,17 @@ interface XFastContextHandler: com::sun::star::uno::XInterface /** receives notification of the beginning of an element . @param Element - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>.<br> + contains the integer token from the XFastTokenHandler + registered at the XFastParser.<br> If the element has a namespace that was registered with the - <type>XFastParser</type>, <param>Element</param> contains the integer - token of the elements local name from the <type>XFastTokenHandler</type> + XFastParser, <param>Element</param> contains the integer + token of the elements local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. @param Attribs - Contains a <type>XFastAttrbitueList</type> to access the attributes + Contains a XFastAttrbitueList to access the attributes from the element. */ @@ -68,7 +68,7 @@ interface XFastContextHandler: com::sun::star::uno::XInterface @param Name contains the elements local name. @param Attribs - Contains a <type>XFastAttrbitueList</type> to access the attributes + Contains a XFastAttrbitueList to access the attributes from the element. */ void startUnknownElement( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs ) @@ -92,17 +92,17 @@ interface XFastContextHandler: com::sun::star::uno::XInterface /** receives notification of the beginning of a known child element. @param Element - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>. + contains the integer token from the XFastTokenHandler + registered at the XFastParser. <br>If the element has a namespace that was registered with the - <type>XFastParser</type>, <param>Element</param> contains the + XFastParser, <param>Element</param> contains the integer token of the elements local name from the - <type>XFastTokenHandler</type> and the integer token of the + XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. @param Attribs - Contains a <type>XFastAttrbitueList</type> to access the attributes + Contains a XFastAttrbitueList to access the attributes from the element. */ XFastContextHandler createFastChildContext( [in] long Element, [in] XFastAttributeList Attribs ) @@ -116,7 +116,7 @@ interface XFastContextHandler: com::sun::star::uno::XInterface @param Name contains the elements local name. @param Attribs - Contains a <type>XFastAttrbitueList</type> to access the attributes + Contains a XFastAttrbitueList to access the attributes the element. */ XFastContextHandler createUnknownChildContext( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs ) diff --git a/offapi/com/sun/star/xml/sax/XFastDocumentHandler.idl b/offapi/com/sun/star/xml/sax/XFastDocumentHandler.idl index 973fd3ac0890..61cb668c00c7 100644 --- a/offapi/com/sun/star/xml/sax/XFastDocumentHandler.idl +++ b/offapi/com/sun/star/xml/sax/XFastDocumentHandler.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module xml { module sax { /** receives notification of sax document events from a - <type>XFastParser</type> + XFastParser */ interface XFastDocumentHandler: XFastContextHandler { diff --git a/offapi/com/sun/star/xml/sax/XFastParser.idl b/offapi/com/sun/star/xml/sax/XFastParser.idl index 2347144e3bcf..e91fa7bd7555 100644 --- a/offapi/com/sun/star/xml/sax/XFastParser.idl +++ b/offapi/com/sun/star/xml/sax/XFastParser.idl @@ -48,10 +48,10 @@ module com { module sun { module star { module xml { module sax { namespaces and allows to have individual contexts for each XML element. <p>Before parsing is possible you have to set your - <type>XFastDocumentHandler</type> using <member>setFastDocumentHandler</member>. + XFastDocumentHandler using <member>setFastDocumentHandler</member>. <p>Parsing starts with calling <member>parseStream</member>. If the parser - finds a valid XML file with the given <type>InputSource</type>, it calls + finds a valid XML file with the given InputSource, it calls <member>XFastDocumentHandler::startDocument</member> first. <p>This parser generates either "fast" events that use integer token @@ -61,13 +61,13 @@ module com { module sun { module star { module xml { module sax { <p>A namespace is unknown if the namespace URL was not registered with <member>registerNamespace</member>. - <p>An element is unknown if no <type>XFastTokenHandler</type> is set - or if the <type>XFastTokenHandler</type> does not return a valid + <p>An element is unknown if no XFastTokenHandler is set + or if the XFastTokenHandler does not return a valid identifier for the elements local name. An element is also unknown if the elements local name is known but it uses a namespace that is unknown. - <p>Setting a <type>XFastTokenHandler</type> with <member>setTokenHandler</member> - is optional, but without a <type>XFastTokenHandler</type> you will only + <p>Setting a XFastTokenHandler with <member>setTokenHandler</member> + is optional, but without a XFastTokenHandler you will only get unknown sax events. This can be useful if you are only interested in the namespace handling and/or the context feature. @@ -76,7 +76,7 @@ module com { module sun { module star { module xml { module sax { <member>XFastContextHandler::createFastChildContext</member> for known elements or <member>XFastContextHandler::createUnknownChildContext</member> for unknown elements. - <br>The parent context for the root element is the <type>XFastDocumentHandler</type> + <br>The parent context for the root element is the XFastDocumentHandler itself. <p>If the parent context returns an empty reference, no further events for @@ -90,12 +90,12 @@ module com { module sun { module star { module xml { module sax { <member>XFastContextHandler::endFastElement</member> for known elements or <member>XFastContextHandler::endUnknownElement</member> for unknown elements. - <p>It is valid to return one instance of <type>XFastContextHandler</type> more - than once. It is even possible to only use the <type>XFastDocumentHandler</type> + <p>It is valid to return one instance of XFastContextHandler more + than once. It is even possible to only use the XFastDocumentHandler by always returning a reference to itself for each create child context event. <p>After the last element is processed the parser generates an end document - event at the <type>XFastDocumentHandler</type> by calling + event at the XFastDocumentHandler by calling <member>XFastDocumentHandler::endDocument</member>. @see http://wiki.services.openoffice.org/wiki/FastParser diff --git a/offapi/com/sun/star/xml/sax/XFastShapeContextHandler.idl b/offapi/com/sun/star/xml/sax/XFastShapeContextHandler.idl index a3105c5c5ee5..bd58164b6f0e 100644 --- a/offapi/com/sun/star/xml/sax/XFastShapeContextHandler.idl +++ b/offapi/com/sun/star/xml/sax/XFastShapeContextHandler.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module xml { module sax { /** receives notification of sax document events from a - <type>XFastParser</type>. + XFastParser. @see XFastDocumentHandler */ diff --git a/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl b/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl index 972bcdf43d9b..ea62913731d8 100644 --- a/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl +++ b/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module xml { module sax { /** interface to translate XML strings to integer tokens. - <p>An instance of this interface can be registered at a <type>XFastParser</type>. + <p>An instance of this interface can be registered at a XFastParser. It should be able to translate all XML names (element local names, attribute local names and constant attribute values) to integer tokens. |