Namespace: Consultingwerk.Studio.ClassDocumentation
Class 
ClassDocumentationParser Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Studio.ClassDocumentation.ClassDocumentationParser

Inherits: Progress.Lang.Object
Implements: Consultingwerk.ISaxReader

File:ClassDocumentationParser
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Sep 10 17:53:07 CEST 2012

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ ParseClassDocumentation (character, dataset) Parses a class doc XML document generated by PCT
+ SaxCharacters (longchar, integer) Invoked when the XML parser detects character data.
+ SaxEndElement (character, character, character) Invoked when the XML parser detects the end of an XML document.
+ SaxStartElement (character, character, character, handle) Invoked when the XML parser detects the beginning of an element.

Top Constructor Summary
Options Name Purpose
+ ClassDocumentationParser () Constructor for the ClassDocumentionParser class


Method Detail
Top

PUBLIC ParseClassDocumentation (character, dataset)
Purpose: Parses a class doc XML document generated by PCT
Notes:

Parameters:
pcFileName CHARACTER
The filename of the XML document generated by the ClassDocumentation task
dsClassDocumentation DATASET
OUTPUT The dataset with the raw class documentation (pass in BY-REFERENCE)
Top

PUBLIC SaxCharacters (longchar, integer)
Purpose: Invoked when the XML parser detects character data.
Notes: The parser calls this method to report each chunk of character data.
It might report contiguous character data in one chunk, or split it
into several chunks. If validation is enabled, whitespace is reported
by the IgnorableWhitespace callback

Parameters:
plcCharData LONGCHAR
A LONGCHAR that contains a chunk of character data.
piNumChars INTEGER
The number of characters contained in the MEMPTR.
Top

PUBLIC SaxEndElement (character, character, character)
Purpose: Invoked when the XML parser detects the end of an XML document.
Notes:

Parameters:
pcNamespaceURI CHARACTER
A character string indicating the namespace URI of the element. If namespace processing is not enabled or the element is not part of a namespace, the string is of length zero.
pcLocalName CHARACTER
A character string indicating the non-prefixed element name. If namespace processing is not enabled, the string is of length zero.
pcName CHARACTER
A character string indicating the actual name of the element in the XML source. If the name has a prefix, qName includes it, whether or not namespace processing is enabled.
Top

PUBLIC SaxStartElement (character, character, character, handle)
Purpose: Invoked when the XML parser detects the beginning of an element.
Notes:

Parameters:
pcNamespaceURI CHARACTER
A character string indicating the namespace URI of the element. If namespace processing is not enabled or the element is not part of a namespace, the string is of length zero.
pcLocalName CHARACTER
A character string indicating the non-prefixed element name. If namespace processing is not enabled, the string is of length zero.
pcName CHARACTER
A character string indicating the actual name of the element in the XML source. If the name has a prefix, qName includes it, whether or not namespace processing is enabled.
phAttributes HANDLE
A handle to a SAX-attributes object, which provides access to all attributes specified for the element. If the element has no attributes, attributes is still a valid handle, and the NUM-ITEMS attribute is zero.


Constructor Detail
Top

PUBLIC ClassDocumentationParser ()
Purpose: Constructor for the ClassDocumentionParser class
Notes:



©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:45:03