summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/xml/sax
diff options
context:
space:
mode:
authorAurimas Fišeras <aurimas@gmail.com>2011-01-28 18:43:28 +0200
committerCaolán McNamara <caolanm@redhat.com>2011-02-01 10:37:11 +0000
commitd2b8cb3cf418d0435e7f222aa33b5ab837f4f69b (patch)
tree16e84e415cfe9624db8e876e036f35b0ee34058e /offapi/com/sun/star/xml/sax
parent0e91a5b571792b6b0ed24eb1157734a2b0ff2543 (diff)
Some fixes to documentation (part 6)
Fixes many spelling errors (checked with en_US spell checker). Unifies spelling of some common words. Replaces single quotes ('') with double quotes (""). Fixes several other errors.
Diffstat (limited to 'offapi/com/sun/star/xml/sax')
-rw-r--r--offapi/com/sun/star/xml/sax/InputSource.idl6
-rw-r--r--offapi/com/sun/star/xml/sax/SAXInvalidCharacterException.idl2
-rw-r--r--offapi/com/sun/star/xml/sax/SAXParseException.idl2
-rw-r--r--offapi/com/sun/star/xml/sax/XEntityResolver.idl8
-rw-r--r--offapi/com/sun/star/xml/sax/XFastAttributeList.idl8
-rw-r--r--offapi/com/sun/star/xml/sax/XFastContextHandler.idl2
-rw-r--r--offapi/com/sun/star/xml/sax/XFastDocumentHandler.idl4
-rw-r--r--offapi/com/sun/star/xml/sax/XFastParser.idl16
-rw-r--r--offapi/com/sun/star/xml/sax/XFastSerializer.idl4
-rw-r--r--offapi/com/sun/star/xml/sax/XFastTokenHandler.idl8
10 files changed, 30 insertions, 30 deletions
diff --git a/offapi/com/sun/star/xml/sax/InputSource.idl b/offapi/com/sun/star/xml/sax/InputSource.idl
index dafffbd31695..d9004b08b1eb 100644
--- a/offapi/com/sun/star/xml/sax/InputSource.idl
+++ b/offapi/com/sun/star/xml/sax/InputSource.idl
@@ -58,7 +58,7 @@ published struct InputSource
//-------------------------------------------------------------------------
/** contains the encoding of the data stream. This is used by the parser
- to do unicode conversions.
+ to do Unicode conversions.
<p>Note that in general you do not need to specify an encoding.
Either it is UTF-8 or UTF-16 which is recognized by the parser
@@ -69,14 +69,14 @@ published struct InputSource
//-------------------------------------------------------------------------
- /** constains the public Id of the document, for example, needed in
+ /** contains the public Id of the document, for example, needed in
exception-message strings.
*/
string sPublicId;
//-------------------------------------------------------------------------
- /** contains the sytemID of the document.
+ /** contains the system ID of the document.
*/
string sSystemId;
};
diff --git a/offapi/com/sun/star/xml/sax/SAXInvalidCharacterException.idl b/offapi/com/sun/star/xml/sax/SAXInvalidCharacterException.idl
index 162d8b3cbb83..9b415b3119fb 100644
--- a/offapi/com/sun/star/xml/sax/SAXInvalidCharacterException.idl
+++ b/offapi/com/sun/star/xml/sax/SAXInvalidCharacterException.idl
@@ -40,7 +40,7 @@ module com { module sun { module star { module xml { module sax {
/** stores information for locating the error in the original XML document.
- @see XLocater
+ @see XLocator
*/
published exception SAXInvalidCharacterException: com::sun::star::xml::sax::SAXException
{
diff --git a/offapi/com/sun/star/xml/sax/SAXParseException.idl b/offapi/com/sun/star/xml/sax/SAXParseException.idl
index 9c7993fb854c..2c56716fa683 100644
--- a/offapi/com/sun/star/xml/sax/SAXParseException.idl
+++ b/offapi/com/sun/star/xml/sax/SAXParseException.idl
@@ -40,7 +40,7 @@ module com { module sun { module star { module xml { module sax {
/** stores information for locating the error in the original XML document.
- @see XLocater
+ @see XLocator
*/
published exception SAXParseException: com::sun::star::xml::sax::SAXException
{
diff --git a/offapi/com/sun/star/xml/sax/XEntityResolver.idl b/offapi/com/sun/star/xml/sax/XEntityResolver.idl
index 0638f72ba94c..63547e260fa8 100644
--- a/offapi/com/sun/star/xml/sax/XEntityResolver.idl
+++ b/offapi/com/sun/star/xml/sax/XEntityResolver.idl
@@ -42,12 +42,12 @@ module com { module sun { module star { module xml { module sax {
//=============================================================================
-/** makes it possible to modify the behaviour of resolving external
+/** makes it possible to modify the behavior of resolving external
preferences.
- <p>Usually, the parser has a default behaviour of resolving external
+ <p>Usually, the parser has a default behavior of resolving external
references (See documentation of the parser implementation).
- Use this interface to modify or reimplement this behaviour.</p>
+ Use this interface to modify or reimplement this behavior.</p>
*/
published interface XEntityResolver: com::sun::star::uno::XInterface
{
@@ -58,7 +58,7 @@ published interface XEntityResolver: com::sun::star::uno::XInterface
<p>If <var>aInputStream</var> is a valid reference to an input stream,
the parser uses this <type>InputSource</type>. Otherwise the
- parser seeks for the entity using its default behaviour.
+ 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/XFastAttributeList.idl b/offapi/com/sun/star/xml/sax/XFastAttributeList.idl
index a48e0e5b9337..4b514e1791bb 100644
--- a/offapi/com/sun/star/xml/sax/XFastAttributeList.idl
+++ b/offapi/com/sun/star/xml/sax/XFastAttributeList.idl
@@ -49,9 +49,9 @@ module com { module sun { module star { module xml { module sax {
//=============================================================================
-/** a container for the attributes of an xml element.
+/** a container for the attributes of an XML element.
- <br>Attributes are seperated into known attributes and unknown attributes.
+ <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
this attributes. If an attribute also has a namespace, that must be registered
@@ -92,7 +92,7 @@ interface XFastAttributeList: com::sun::star::uno::XInterface
@returns
The integer token of the value from the attribute or <const>FastToken::Invalid</const>
- @raises SAXEXception
+ @raises SAXException
if the attribute is not available
*/
@@ -137,7 +137,7 @@ interface XFastAttributeList: com::sun::star::uno::XInterface
@returns
The string value from the attribute.
- @raises SAXEXception
+ @raises SAXException
if the attribute is not available
*/
diff --git a/offapi/com/sun/star/xml/sax/XFastContextHandler.idl b/offapi/com/sun/star/xml/sax/XFastContextHandler.idl
index 22feebe6f5a0..1449e3fbc4b5 100644
--- a/offapi/com/sun/star/xml/sax/XFastContextHandler.idl
+++ b/offapi/com/sun/star/xml/sax/XFastContextHandler.idl
@@ -104,7 +104,7 @@ interface XFastContextHandler: com::sun::star::uno::XInterface
//-------------------------------------------------------------------------
- /** receives notification of the end of an kown element.
+ /** receives notification of the end of an known element.
@see startUnknownElement
*/
void endUnknownElement( [in] string Namespace, [in] string Name )
diff --git a/offapi/com/sun/star/xml/sax/XFastDocumentHandler.idl b/offapi/com/sun/star/xml/sax/XFastDocumentHandler.idl
index a4b5c94b8142..af9e2b2aef41 100644
--- a/offapi/com/sun/star/xml/sax/XFastDocumentHandler.idl
+++ b/offapi/com/sun/star/xml/sax/XFastDocumentHandler.idl
@@ -61,14 +61,14 @@ interface XFastDocumentHandler: XFastContextHandler
{
//-------------------------------------------------------------------------
- /** called by the parser when parsing of an xml stream is started.
+ /** called by the parser when parsing of an XML stream is started.
*/
void startDocument()
raises( com::sun::star::xml::sax::SAXException );
//-------------------------------------------------------------------------
- /** called by the parser after the last xml element of a stream is processed.
+ /** called by the parser after the last XML element of a stream is processed.
*/
void endDocument()
raises( com::sun::star::xml::sax::SAXException );
diff --git a/offapi/com/sun/star/xml/sax/XFastParser.idl b/offapi/com/sun/star/xml/sax/XFastParser.idl
index 037aa01f913b..e2e2d1e31418 100644
--- a/offapi/com/sun/star/xml/sax/XFastParser.idl
+++ b/offapi/com/sun/star/xml/sax/XFastParser.idl
@@ -77,19 +77,19 @@ module com { module sun { module star { module xml { module sax {
//=============================================================================
-/** specifies a SAX parser that uses integer values for known xml names
+/** specifies a SAX parser that uses integer values for known XML names
(elements, attributes and attribute values). The parser also handles
- namespaces and allows to have individual contexts for each xml element.
+ 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>.
<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 <type>InputSource</type>, it calls
<member>XFastDocumentHandler::startDocument</member> first.
- <p>This parser generates either 'fast' events that use integer token
- values for namespaces, elements and attributes or 'unknown' events for
+ <p>This parser generates either "fast" events that use integer token
+ values for namespaces, elements and attributes or "unknown" events for
elements that are unknown.
<p>A namespace is unknown if the namespace URL was not registered with
@@ -102,7 +102,7 @@ module com { module sun { module star { module xml { module sax {
<p>Setting a <type>XFastTokenHandler</type> with <member>setTokenHandler</member>
is optional, but without a <type>XFastTokenHandler</type> you will only
- get unknown sax events. This can be usefull if you are only interested
+ get unknown sax events. This can be useful if you are only interested
in the namespace handling and/or the context feature.
<p>For each element the parser sends a create child element event to the
@@ -114,7 +114,7 @@ module com { module sun { module star { module xml { module sax {
itself.
<p>If the parent context returns an empty reference, no further events for
- the element and all of its childs are created.
+ the element and all of its children are created.
<p>If a valid context is returned this context gets a start event by a call to
<member>XFastContextHandler::startFastElement</member> for known elements or
@@ -153,7 +153,7 @@ interface XFastParser: com::sun::star::uno::XInterface
//-------------------------------------------------------------------------
- /** must be registered to translate known xml names to integer tokens.
+ /** must be registered to translate known XML names to integer tokens.
*/
void setTokenHandler( [in] XFastTokenHandler Handler );
diff --git a/offapi/com/sun/star/xml/sax/XFastSerializer.idl b/offapi/com/sun/star/xml/sax/XFastSerializer.idl
index 3c61d0ffcbf4..5d1591490bb5 100644
--- a/offapi/com/sun/star/xml/sax/XFastSerializer.idl
+++ b/offapi/com/sun/star/xml/sax/XFastSerializer.idl
@@ -60,14 +60,14 @@ interface XFastSerializer: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
- /** called by the parser when parsing of an xml stream is started.
+ /** called by the parser when parsing of an XML stream is started.
*/
void startDocument()
raises( com::sun::star::xml::sax::SAXException );
//-------------------------------------------------------------------------
- /** called by the parser after the last xml element of a stream is processed.
+ /** called by the parser after the last XML element of a stream is processed.
*/
void endDocument()
raises( com::sun::star::xml::sax::SAXException );
diff --git a/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl b/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl
index e4af64500b6c..0f1063479edc 100644
--- a/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl
+++ b/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl
@@ -37,10 +37,10 @@ module com { module sun { module star { module xml { module sax {
//============================================================================
-/** interface to translate xml strings to integer tokens.
+/** interface to translate XML strings to integer tokens.
<p>An instance of this interface can be registered at a <type>XFastParser</type>.
- It should be able to translate all xml names (element local names,
+ It should be able to translate all XML names (element local names,
attribute local names and constant attribute values) to integer tokens.
A token value must be greater or equal to zero and less than
@@ -70,7 +70,7 @@ interface XFastTokenHandler: com::sun::star::uno::XInterface
/** returns a integer token for the given string
@param Identifier
- the string given as a byte sequence encoded in UTF8
+ the string given as a byte sequence encoded in UTF-8
@returns
a unique integer token for the given String or <const>FastToken::DONTKNOW</const>
@@ -81,7 +81,7 @@ interface XFastTokenHandler: com::sun::star::uno::XInterface
//-------------------------------------------------------------------------
/** returns a identifier for the given integer token as a byte
- sequence encoded in UTF8.
+ sequence encoded in UTF-8.
*/
sequence< byte > getUTF8Identifier( [in] long Token );
};