From f4c79ca075042b834ba04adbd32b1973245089a0 Mon Sep 17 00:00:00 2001 From: un1versal Date: Wed, 9 Dec 2015 12:00:31 +0000 Subject: src/modules: typos, consistency capitalize, fomatting and indenting fixes these contains in addition the whitespace changes --- src/modules/objects/KvsObject_xmlreader.cpp | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) (limited to 'src/modules/objects/KvsObject_xmlreader.cpp') diff --git a/src/modules/objects/KvsObject_xmlreader.cpp b/src/modules/objects/KvsObject_xmlreader.cpp index 8cf692938..bda1f651f 100644 --- a/src/modules/objects/KvsObject_xmlreader.cpp +++ b/src/modules/objects/KvsObject_xmlreader.cpp @@ -38,11 +38,11 @@ @type: class @short: - A simple xml document parser + A simple XML document parser @inherits: [class]object[/class] @description: - This class implements a really simple xml document parser. + This class implements a really simple XML document parser. You will usually derive your own class from this one and reimplement some of the events that it triggers. You will typically reimplement [classfnc:xmlreader]$onElementStart[/classfnc]() @@ -64,59 +64,51 @@ in the document, user abort etc...). If this function return $false then you can call $lastError() to obtain a descriptive error message. - !fn: $lastError() Returns the last error occurred inside the parser. You will typically call this function when $parse() above returns $false. - !fn: $onDocumentStart() This function is called when the document parsing starts. You can reimplement it in order to handle this notification. You should return $true if you want document parsing to continue and $false if you want it to be aborted. The default implementation does nothing besides returning $true. - !fn: $onDocumentEnd() This function is called when the document parsing terminates successfully. You can reimplement it in order to handle this notification. You should return $true if you want document parsing to continue and $false if you want it to be aborted. The default implementation does nothing besides returning $true. - !fn: $onElementStart(,,,) This function is called when an element opening tag is encountered. The of the tag is passed as the first parameter. The are passed in the form of a hash with attribute values indexed by their names. When the contains a namespace then it is also reported - in the splitted pair. + in the split pair. You should return $true if you want document parsing to continue and $false if you want it to be aborted. The default implementation does nothing besides returning $true. - !fn: $onElementEnd(,,) This function is called when an element closing tag is encountered. The of the tag is passed as the first parameter. When the contains a namespace then it is also reported - in the splitted pair. + in the split pair. You should return $true if you want document parsing to continue and $false if you want it to be aborted. The default implementation does nothing besides returning $true. - !fn: $onText($0 = ) This function is called when a chunk of text is encountered inside the document. The parsed chunk is passed as the first parameter. You should return $true if you want document parsing to continue and $false if you want it to be aborted. The default implementation does nothing besides returning $true. - !fn: $onWarning() This function is called when the parser generates a recoverable error. The error is passed as the first parameter. You should return $true if you want document parsing to continue and $false if you want it to be aborted. The default implementation does nothing besides returning $true. - !fn: $onError() This function is called when the parser generates an unrecoverable error. The error is passed as the first parameter. -- cgit v1.3.1-10-gc9f91