[fdo-commits] r732 - in branches/3.2.x/Fdo/Managed/Src/OSGeo/Common: . Io Xml Xsl

svn_fdo at osgeo.org svn_fdo at osgeo.org
Wed Feb 7 16:28:04 EST 2007


Author: gregboone
Date: 2007-02-07 16:28:04 -0500 (Wed, 07 Feb 2007)
New Revision: 732

Modified:
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoByteStreamReader.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoCharStreamReader.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoStream.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttribute.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttributeCollection.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlCopyHandler.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlReader.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlWriter.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xsl/mgXslTransformer.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionary.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgException.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgStringCollection.h
Log:
893057: DOC: FDO Managed API Documentation Updates

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoByteStreamReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoByteStreamReader.h	2007-02-07 21:26:44 UTC (rev 731)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoByteStreamReader.h	2007-02-07 21:28:04 UTC (rev 732)
@@ -52,6 +52,19 @@
 	System::Void Reset();  
 
     /// \brief
+    ///     Reads in the next block of items. The caller is responsible to allocate a buffer large 
+    ///     enough to store data.
+    /// 
+    /// \param buffer 
+    ///     Output array holding data read in.
+    ///
+    /// \return
+    ///     Returns the number of items actually read in. When 0 (zero) then the 
+    ///     end-of-stream was reached.
+    /// 
+	System::Int32 ReadNext(System::Byte buffer[]);
+
+    /// \brief
     ///     Reads in the next block of items. Use ReadNext( buffer) to read in 
     ///     the entire stream. The caller is responsible to allocate a buffer large 
     ///     enough to store data.
@@ -64,6 +77,25 @@
     ///     If zero, then the buffer is reused. If the end of the buffer, then read in 
     ///     appending mode. Throws "out-of-bounds" exception if not in this range.
     ///
+    /// \return
+    ///     Returns the number of items actually read in. When 0 (zero) then the 
+    ///     end-of-stream was reached.
+    /// 
+	System::Int32 ReadNext(System::Byte buffer[], System::Int32 offset);
+
+    /// \brief
+    ///     Reads in the next block of items. Use ReadNext( buffer) to read in 
+    ///     the entire stream. The caller is responsible to allocate a buffer large 
+    ///     enough to store data.
+    /// 
+    /// \param buffer 
+    ///     Output array holding data read in.
+    ///
+    /// \param offset 
+    ///     Input index in the array indicating the beginning of the output buffer. 
+    ///     If zero, then the buffer is reused. If the end of the buffer, then read in 
+    ///     appending mode. Throws "out-of-bounds" exception if not in this range.
+    ///
     /// \param count 
     ///     Input number of items to be read in. If -1 read the entire stream.
     ///     Throws "out-of-bounds"  exception if not a positive value or -1.
@@ -72,9 +104,7 @@
     ///     Returns the number of items actually read in. When 0 (zero) then the 
     ///     end-of-stream was reached.
     /// 
-	System::Int32 ReadNext(System::Byte buffer[]);
-	System::Int32 ReadNext(System::Byte buffer[], System::Int32 offset);
-	System::Int32 ReadNext(System::Byte buffer[], System::Int32 offset, System::Int32 count);
+    System::Int32 ReadNext(System::Byte buffer[], System::Int32 offset, System::Int32 count);
 
     /// \brief
     ///     Gets the stream length

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoCharStreamReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoCharStreamReader.h	2007-02-07 21:26:44 UTC (rev 731)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoCharStreamReader.h	2007-02-07 21:28:04 UTC (rev 732)
@@ -45,6 +45,19 @@
 	System::Void Reset();  
 
     /// \brief
+    ///     Reads in the next block of items. The caller is responsible to allocate a buffer large 
+    ///     enough to store data.
+    /// 
+    /// \param buffer 
+    ///     Output array holding data read in.
+    ///
+    /// \return
+    ///     Returns the number of items actually read in. When 0 (zero) then the 
+    ///     end-of-stream was reached.
+    /// 
+	System::Int32 ReadNext(System::Char buffer[]);
+
+    /// \brief
     ///     Reads in the next block of items. Use ReadNext( buffer) to read in 
     ///     the entire stream. The caller is responsible to allocate a buffer large 
     ///     enough to store data.
@@ -57,6 +70,25 @@
     ///     If zero, then the buffer is reused. If the end of the buffer, then read in 
     ///     appending mode. Throws "out-of-bounds" exception if not in this range.
     ///
+    /// \return
+    ///     Returns the number of items actually read in. When 0 (zero) then the 
+    ///     end-of-stream was reached.
+    /// 
+    System::Int32 ReadNext(System::Char buffer[], System::Int32 offset);
+
+    /// \brief
+    ///     Reads in the next block of items. Use ReadNext( buffer) to read in 
+    ///     the entire stream. The caller is responsible to allocate a buffer large 
+    ///     enough to store data.
+    /// 
+    /// \param buffer 
+    ///     Output array holding data read in.
+    ///
+    /// \param offset 
+    ///     Input index in the array indicating the beginning of the output buffer. 
+    ///     If zero, then the buffer is reused. If the end of the buffer, then read in 
+    ///     appending mode. Throws "out-of-bounds" exception if not in this range.
+    ///
     /// \param count 
     ///     Input number of items to be read in. If -1 read the entire stream.
     ///     Throws "out-of-bounds"  exception if not a positive value or -1.
@@ -65,8 +97,6 @@
     ///     Returns the number of items actually read in. When 0 (zero) then the 
     ///     end-of-stream was reached.
     /// 
-	System::Int32 ReadNext(System::Char buffer[]);
-	System::Int32 ReadNext(System::Char buffer[], System::Int32 offset);
 	System::Int32 ReadNext(System::Char buffer[], System::Int32 offset, System::Int32 count);
 
     /// \brief

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoStream.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoStream.h	2007-02-07 21:26:44 UTC (rev 731)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Io/mgIoStream.h	2007-02-07 21:28:04 UTC (rev 732)
@@ -55,16 +55,16 @@
     ///     to the stream. The current position is moved ahead by the number of bytes 
     ///     written.
     /// 
-    /// \remarks
-    ///     Note: Write will overwrite some of the contents of the stream 
-    ///     if the current position is not at the end of the stream.
-    /// 
     /// \param buffer 
     ///     Intput write from this buffer
     ///
     /// \param count 
     ///     Input number of bytes to write
     /// 
+    /// \remarks
+    ///     Note: Write will overwrite some of the contents of the stream 
+    ///     if the current position is not at the end of the stream.
+    /// 
 	virtual System::Void Write(System::Byte buffer[], System::UInt32 count);
 
     /// \brief
@@ -74,11 +74,19 @@
     /// \param stream 
     ///     Input write from this buffer
     ///
+	virtual System::Void Write(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
+
+    /// \brief
+    ///     reads the number of bytes from the given stream, and writes them 
+    ///     to this stream. 
+    /// 
+    /// \param stream 
+    ///     Input write from this buffer
+    ///
     /// \param count 
     ///     Input the maximum number of bytes to read and write.
     ///     When 0, all remaining bytes are read from the given stream.
     /// 
-	virtual System::Void Write(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
 	virtual System::Void Write(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, System::UInt32 count);
 
     /// \brief

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttribute.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttribute.h	2007-02-07 21:26:44 UTC (rev 731)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttribute.h	2007-02-07 21:28:04 UTC (rev 732)
@@ -40,13 +40,13 @@
     /// Input attribute value.
     /// \param localName 
     /// Input attribute name without namespace qualification.
-    /// \param uri 
+    /// \param attributeURI 
     /// Input uri for the attribute namespace. L"" if the attribute
     /// name is not namespace qualified.
     /// \param prefix 
     /// Input prefix for the attribute namespace. L"" if the attribute
     /// name is not namespace qualified.
-    /// \param valueUri 
+    /// \param valueURI 
     /// Input uri for the attribute value's namespace. L"" if the attribute
     /// value is not namespace qualified.
     /// \param localValue 
@@ -55,15 +55,109 @@
     /// Input prefix for the attribute value's namespace. L"" if the attribute
     /// value is not namespace qualified.
     /// 
-    /// \return
-    /// Returns XmlAttribute
+	XmlAttribute(System::String* name, System::String* value, System::String* localName, System::String* attributeURI, System::String* prefix, System::String* valueURI, System::String* localValue, System::String* valuePrefix);
+
+    /// \brief
+    /// Constructs an XML Attribute object
     /// 
-	XmlAttribute(System::String* name, System::String* value, System::String* localName, System::String* attributeURI, System::String* prefix, System::String* valueURI, System::String* localValue, System::String* valuePrefix);
+    /// \param name 
+    /// Input unique attribute name. If the attribute name is namespace qualified
+    /// the name is {uri}:{localName}. Otherwise, it is {localName}
+    /// \param value 
+    /// Input attribute value.
+    /// \param localName 
+    /// Input attribute name without namespace qualification.
+    /// \param attributeURI 
+    /// Input uri for the attribute namespace. L"" if the attribute
+    /// name is not namespace qualified.
+    /// \param prefix 
+    /// Input prefix for the attribute namespace. L"" if the attribute
+    /// name is not namespace qualified.
+    /// \param valueURI 
+    /// Input uri for the attribute value's namespace. L"" if the attribute
+    /// value is not namespace qualified.
+    /// \param localValue 
+    /// Input attribute value without namespace qualification.
+    /// 
 	XmlAttribute(System::String* name, System::String* value, System::String* localName, System::String* attributeURI, System::String* prefix, System::String* valueURI, System::String* localValue);
+
+    /// \brief
+    /// Constructs an XML Attribute object
+    /// 
+    /// \param name 
+    /// Input unique attribute name. If the attribute name is namespace qualified
+    /// the name is {uri}:{localName}. Otherwise, it is {localName}
+    /// \param value 
+    /// Input attribute value.
+    /// \param localName 
+    /// Input attribute name without namespace qualification.
+    /// \param attributeURI 
+    /// Input uri for the attribute namespace. L"" if the attribute
+    /// name is not namespace qualified.
+    /// \param prefix 
+    /// Input prefix for the attribute namespace. L"" if the attribute
+    /// name is not namespace qualified.
+    /// \param valueURI 
+    /// Input uri for the attribute value's namespace. L"" if the attribute
+    /// value is not namespace qualified.
+    /// 
 	XmlAttribute(System::String* name, System::String* value, System::String* localName, System::String* attributeURI, System::String* prefix, System::String* valueURI);
+
+    /// \brief
+    /// Constructs an XML Attribute object
+    /// 
+    /// \param name 
+    /// Input unique attribute name. If the attribute name is namespace qualified
+    /// the name is {uri}:{localName}. Otherwise, it is {localName}
+    /// \param value 
+    /// Input attribute value.
+    /// \param localName 
+    /// Input attribute name without namespace qualification.
+    /// \param attributeURI 
+    /// Input uri for the attribute namespace. L"" if the attribute
+    /// name is not namespace qualified.
+    /// \param prefix 
+    /// Input prefix for the attribute namespace. L"" if the attribute
+    /// name is not namespace qualified.
+    /// 
 	XmlAttribute(System::String* name, System::String* value, System::String* localName, System::String* attributeURI, System::String* prefix);
+    /// \brief
+    /// Constructs an XML Attribute object
+    /// 
+    /// \param name 
+    /// Input unique attribute name. If the attribute name is namespace qualified
+    /// the name is {uri}:{localName}. Otherwise, it is {localName}
+    /// \param value 
+    /// Input attribute value.
+    /// \param localName 
+    /// Input attribute name without namespace qualification.
+    /// \param attributeURI 
+    /// Input uri for the attribute namespace. L"" if the attribute
+    /// name is not namespace qualified.
+    /// 
 	XmlAttribute(System::String* name, System::String* value, System::String* localName, System::String* attributeURI);
+    /// \brief
+    /// Constructs an XML Attribute object
+    /// 
+    /// \param name 
+    /// Input unique attribute name. If the attribute name is namespace qualified
+    /// the name is {uri}:{localName}. Otherwise, it is {localName}
+    /// \param value 
+    /// Input attribute value.
+    /// \param localName 
+    /// Input attribute name without namespace qualification.
+    /// 
 	XmlAttribute(System::String* name, System::String* value, System::String* localName);
+
+    /// \brief
+    /// Constructs an XML Attribute object
+    /// 
+    /// \param name 
+    /// Input unique attribute name. If the attribute name is namespace qualified
+    /// the name is {uri}:{localName}. Otherwise, it is {localName}
+    /// \param value 
+    /// Input attribute value.
+    /// 
 	XmlAttribute(System::String* name, System::String* value);
 
     /// \brief

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttributeCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttributeCollection.h	2007-02-07 21:26:44 UTC (rev 731)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttributeCollection.h	2007-02-07 21:28:04 UTC (rev 732)
@@ -204,7 +204,7 @@
     /// \brief
     ///     Determines the index of a specific XmlAttribute object.
     /// 
-    /// \param value 
+    /// \param name 
     ///     Input the name of the XmlAttribute object to locate in the collection.
     /// 
     /// \return
@@ -245,7 +245,7 @@
     /// \brief
     ///     Determines whether the collection contains a specific XmlAttribute object.
     /// 
-    /// \param value 
+    /// \param name 
     ///     Input The name of the XmlAttribute object to search in the collection.
     /// 
     /// \return
@@ -259,26 +259,53 @@
     /// \param array 
     ///     Output the one-dimensional Array that is the destination of the elements copied from this collection.
     ///
-    /// \param startAt 
+    /// \param index 
     ///     Input an integer that represents the index in array at which copying begins.
     /// 
-	System::Void CopyTo(XmlAttribute* array[],System::Int32 size);
+	System::Void CopyTo(XmlAttribute* array[],System::Int32 index);
 
     /// \brief
-    ///     Gets or sets a XmlAttribute in the collection.
+    ///     Gets an XmlAttribute in the collection.
     /// 
     /// \param index 
-    ///     Input index of the XmlAttribute to retrieve or set (System::Int32).
+    ///     Input index of the XmlAttribute to retrieve.
     /// 
+    /// \return 
+    ///     An XmlAttribute found in the collection
+    /// 
+	__property XmlAttribute* get_RealTypeItem(System::Int32 index);
+
+    /// \brief
+    ///     Sets an XmlAttribute in the collection.
+    /// 
+    /// \param index 
+    ///     Input index of the XmlAttribute to set.
+    /// 
     /// \param value 
     ///     Input the value of the XmlAttribute
     /// 
-	__property XmlAttribute* get_RealTypeItem(System::Int32 index);
-
 	__property System::Void  set_RealTypeItem(System::Int32 index, XmlAttribute* value);
 
+    /// \brief
+    ///     Gets an XmlAttribute in the collection.
+    /// 
+    /// \param index 
+    ///     Input index of the XmlAttribute to retrieve.
+    /// 
+    /// \return 
+    ///     An XmlAttribute found in the collection
+    /// 
 	__property XmlAttribute* get_Item(System::Int32 index);
 
+    /// \brief
+    ///     Sets an XmlAttribute in the collection.
+    /// 
+    /// \param index 
+    ///     Input index of the XmlAttribute to set.
+    /// 
+    /// \param value 
+    ///     Input the value of the XmlAttribute
+    /// 
 	__property System::Void  set_Item(System::Int32 index, XmlAttribute* value);
 };
 

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlCopyHandler.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlCopyHandler.h	2007-02-07 21:26:44 UTC (rev 731)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlCopyHandler.h	2007-02-07 21:28:04 UTC (rev 732)
@@ -59,13 +59,13 @@
     /// 
     /// \param writer 
     /// Input the sub-elements are written to this XML writer.
-    /// \param uri 
+    /// \param resourceLocation 
     /// Input current element's Universal Resource Indicator
     /// \param name 
     /// Input the unqualified name of the current element (doesn't include namespace)
-    /// \param qname 
+    /// \param qualifiedName 
     /// Input the qualified name of the current element(includes namespace)
-    /// \param atts 
+    /// \param attributes 
     /// Input the attributes for the current element. 
     /// <p><b>Note:</b> If the 
     /// current element will become the root element in the destination 

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlReader.h	2007-02-07 21:26:44 UTC (rev 731)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlReader.h	2007-02-07 21:28:04 UTC (rev 732)
@@ -109,6 +109,14 @@
     /// \brief
     /// Parses the XML document.
     /// 
+    /// \return
+    /// Returns true if the end of the document has not yet been reached
+    /// 
+    System::Boolean Parse();
+
+    /// \brief
+    /// Parses the XML document.
+    /// 
     /// \param saxHandler 
     /// Input SAX Handler to receive the SaxHandler events.
     /// This object is pushed onto the SAX Handler stack when parse() starts and popped
@@ -116,9 +124,44 @@
     /// the current top SAX Handler receives the events. If saxHander is NULL
     /// and there is on current top SAX Handler then this function does a 
     /// parse and reports syntax errors, but does no semantic processing.
+    /// 
+    /// \return
+    /// Returns true if the end of the document has not yet been reached
+    /// 
+    System::Boolean Parse(NAMESPACE_OSGEO_COMMON_XML::IXmlSaxHandler* saxHandler);
+
+    /// \brief
+    /// Parses the XML document.
+    /// 
+    /// \param saxHandler 
+    /// Input SAX Handler to receive the SaxHandler events.
+    /// This object is pushed onto the SAX Handler stack when parse() starts and popped
+    /// when parse() is finished. If NULL then no handler is pushed, meaning that
+    /// the current top SAX Handler receives the events. If saxHander is NULL
+    /// and there is on current top SAX Handler then this function does a 
+    /// parse and reports syntax errors, but does no semantic processing.
     /// \param saxContext 
     /// Input Caller-specific contextual information that is 
     /// pass to all SAX callbacks.
+    /// 
+    /// \return
+    /// Returns true if the end of the document has not yet been reached
+    /// 
+    System::Boolean Parse(NAMESPACE_OSGEO_COMMON_XML::IXmlSaxHandler* saxHandler, NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* saxContext);
+
+    /// \brief
+    /// Parses the XML document.
+    /// 
+    /// \param saxHandler 
+    /// Input SAX Handler to receive the SaxHandler events.
+    /// This object is pushed onto the SAX Handler stack when parse() starts and popped
+    /// when parse() is finished. If NULL then no handler is pushed, meaning that
+    /// the current top SAX Handler receives the events. If saxHander is NULL
+    /// and there is on current top SAX Handler then this function does a 
+    /// parse and reports syntax errors, but does no semantic processing.
+    /// \param saxContext 
+    /// Input Caller-specific contextual information that is 
+    /// pass to all SAX callbacks.
     /// \param incremental 
     /// Input 
     /// true: an incremental (progressive) parse is performed. The first call 
@@ -134,9 +177,6 @@
     /// \return
     /// Returns true if the end of the document has not yet been reached
     /// 
-    System::Boolean Parse();
-    System::Boolean Parse(NAMESPACE_OSGEO_COMMON_XML::IXmlSaxHandler* saxHandler);
-    System::Boolean Parse(NAMESPACE_OSGEO_COMMON_XML::IXmlSaxHandler* saxHandler, NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* saxContext);
     System::Boolean Parse(NAMESPACE_OSGEO_COMMON_XML::IXmlSaxHandler* saxHandler, NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* saxContext, System::Boolean incremental);
 
     /// \brief

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlWriter.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlWriter.h	2007-02-07 21:26:44 UTC (rev 731)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlWriter.h	2007-02-07 21:28:04 UTC (rev 732)
@@ -89,15 +89,53 @@
     /// written, if the attribute would have caused the current line to exceed
     /// this length.
     /// 
-    /// \return
-    /// Returns XmlWriter
+	XmlWriter(System::String* fileName, System::Boolean defaultRoot, NAMESPACE_OSGEO_COMMON_XML::XmlWriter::LineFormat lineFormat, System::UInt32 lineLength);
+
+    /// \brief
+    /// Constructs an XML writer on a file
     /// 
-	XmlWriter(System::String* fileName, System::Boolean defaultRoot, NAMESPACE_OSGEO_COMMON_XML::XmlWriter::LineFormat lineFormat, System::UInt32 lineLength);
-	XmlWriter(System::String* fileName, System::Boolean defaultRoot, NAMESPACE_OSGEO_COMMON_XML::XmlWriter::LineFormat lineFormat);
+    /// \param fileName 
+    /// Input name of the file to write.
+    /// \param defaultRoot 
+    /// true: all elements written are wrapped in a default root element, named "DataStore".
+    /// false: the default root element is not written. In this case, the first 
+    /// element written (via  WriteStartElement() ) becomes the root element. 
+    /// The caller is responsible for ensuring that only one root element is written 
+    /// (the XML standard disallows multiple root elements).
+    /// \param lineFormat 
+    /// Input indentation string for XML elements. If NULL
+    /// the XML document contains no line breaks and elements are not indented. 
+    /// if L"" then the XML document has a line break after every end element
+    /// tag but no elements are indented. Otherwise, this string must only 
+    /// contain spaces or tabs; the XML document has a line break after every end element
+    /// and each element start is prepended with a repetition of this string.
+    /// The string is repeated according to the element's nesting level.
+    /// 
+    XmlWriter(System::String* fileName, System::Boolean defaultRoot, NAMESPACE_OSGEO_COMMON_XML::XmlWriter::LineFormat lineFormat);
+
+    /// \brief
+    /// Constructs an XML writer on a file
+    /// 
+    /// \param fileName 
+    /// Input name of the file to write.
+    /// \param defaultRoot 
+    /// true: all elements written are wrapped in a default root element, named "DataStore".
+    /// false: the default root element is not written. In this case, the first 
+    /// element written (via  WriteStartElement() ) becomes the root element. 
+    /// The caller is responsible for ensuring that only one root element is written 
+    /// (the XML standard disallows multiple root elements).
+    /// 
 	XmlWriter(System::String* fileName, System::Boolean defaultRoot);
-	XmlWriter(System::String* fileName);
 
     /// \brief
+    /// Constructs an XML writer on a file
+    /// 
+    /// \param fileName 
+    /// Input name of the file to write.
+    /// 
+    XmlWriter(System::String* fileName);
+
+    /// \brief
     /// Constructs an XML writer on a stream
     /// 
     /// \param stream 
@@ -122,12 +160,43 @@
     /// written, if the attribute would have caused the current line to exceed
     /// this length.
     /// 
-    /// \return
-    /// Returns XmlWriter
+	XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, System::Boolean defaultRoot, NAMESPACE_OSGEO_COMMON_XML::XmlWriter::LineFormat lineFormat, System::UInt32 lineLength);
+
+    /// \brief
+    /// Constructs an XML writer on a stream
     /// 
-	XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, System::Boolean defaultRoot, NAMESPACE_OSGEO_COMMON_XML::XmlWriter::LineFormat lineFormat, System::UInt32 lineLength);
-	XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, System::Boolean defaultRoot, NAMESPACE_OSGEO_COMMON_XML::XmlWriter::LineFormat lineFormat);
-	XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, System::Boolean defaultRoot);
+    /// \param stream 
+    /// Input the stream to write.
+    /// \param defaultRoot 
+    /// true: all elements written are wrapped in a default root element, named "DataStore".
+    /// false: the default root element is not written. In this case, the first 
+    /// element written (via  WriteStartElement() ) becomes the root element. 
+    /// The caller is responsible for ensuring that only one root element is written 
+    /// (the XML standard disallows multiple root elements).
+    /// \param lineFormat 
+    /// 
+    XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, System::Boolean defaultRoot, NAMESPACE_OSGEO_COMMON_XML::XmlWriter::LineFormat lineFormat);
+
+    /// \brief
+    /// Constructs an XML writer on a stream
+    /// 
+    /// \param stream 
+    /// Input the stream to write.
+    /// \param defaultRoot 
+    /// true: all elements written are wrapped in a default root element, named "DataStore".
+    /// false: the default root element is not written. In this case, the first 
+    /// element written (via  WriteStartElement() ) becomes the root element. 
+    /// The caller is responsible for ensuring that only one root element is written 
+    /// (the XML standard disallows multiple root elements).
+    /// 
+    XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, System::Boolean defaultRoot);
+
+    /// \brief
+    /// Constructs an XML writer on a stream
+    /// 
+    /// \param stream 
+    /// Input the stream to write.
+    /// 
 	XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
 
     /// \brief
@@ -155,15 +224,53 @@
     /// written, if the attribute would have caused the current line to exceed
     /// this length.
     /// 
-    /// \return
-    /// Returns XmlWriter
-    /// 
 	XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* writer, System::Boolean defaultRoot, NAMESPACE_OSGEO_COMMON_XML::XmlWriter::LineFormat lineFormat, System::UInt32 lineLength);
-	XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* writer, System::Boolean defaultRoot, NAMESPACE_OSGEO_COMMON_XML::XmlWriter::LineFormat lineFormat);
-	XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* writer, System::Boolean defaultRoot);
-	XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* writer);
 
     /// \brief
+    /// Constructs an XML writer on a text writer
+    /// 
+    /// \param writer 
+    /// Input the text writer.
+    /// \param defaultRoot 
+    /// true: all elements written are wrapped in a default root element, named "DataStore".
+    /// false: the default root element is not written. In this case, the first 
+    /// element written (via  WriteStartElement() ) becomes the root element. 
+    /// The caller is responsible for ensuring that only one root element is written 
+    /// (the XML standard disallows multiple root elements).
+    /// \param lineFormat 
+    /// Input indentation string for XML elements. If NULL
+    /// the XML document contains no line breaks and elements are not indented. 
+    /// if L"" then the XML document has a line break after every end element
+    /// tag but no elements are indented. Otherwise, this string must only 
+    /// contain spaces or tabs; the XML document has a line break after every end element
+    /// and each element start is prepended with a repetition of this string.
+    /// The string is repeated according to the element's nesting level.
+    /// 
+    XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* writer, System::Boolean defaultRoot, NAMESPACE_OSGEO_COMMON_XML::XmlWriter::LineFormat lineFormat);
+
+    /// \brief
+    /// Constructs an XML writer on a text writer
+    /// 
+    /// \param writer 
+    /// Input the text writer.
+    /// \param defaultRoot 
+    /// true: all elements written are wrapped in a default root element, named "DataStore".
+    /// false: the default root element is not written. In this case, the first 
+    /// element written (via  WriteStartElement() ) becomes the root element. 
+    /// The caller is responsible for ensuring that only one root element is written 
+    /// (the XML standard disallows multiple root elements).
+    /// 
+    XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* writer, System::Boolean defaultRoot);
+
+    /// \brief
+    /// Constructs an XML writer on a text writer
+    /// 
+    /// \param writer 
+    /// Input the text writer.
+    /// 
+    XmlWriter(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* writer);
+
+    /// \brief
     /// Gets the underlying text writer. If a text writer was passed to this object
     /// then this text writeer is returned.
     /// Otherwise, an auto-generated text writer is returned (a text writer
@@ -256,9 +363,12 @@
     /// for ensuring that the text does not introduce any errors into the 
     /// XML document.
     /// 
-    /// \param characters 
+    /// \param bytes 
     /// Input characters to write.
     /// 
+    /// \param count 
+    /// Input the number of bytes to write
+    /// 
 	System::Void WriteBytes( System::Byte bytes [],  System::UInt32 count );
 
     /// \brief

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xsl/mgXslTransformer.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xsl/mgXslTransformer.h	2007-02-07 21:26:44 UTC (rev 731)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xsl/mgXslTransformer.h	2007-02-07 21:28:04 UTC (rev 732)
@@ -43,23 +43,58 @@
     /// \brief
     /// Constructs an XSL Transformer object.
     /// 
+	XslTransformer();
+
+    /// \brief
+    /// Constructs an XSL Transformer object.
+    /// 
     /// \param inDoc 
     /// Input the XML document to transform.
+    /// 
+    XslTransformer(NAMESPACE_OSGEO_COMMON_XML::XmlReader* inDoc);
+
+    /// \brief
+    /// Constructs an XSL Transformer object.
+    /// 
+    /// \param inDoc 
+    /// Input the XML document to transform.
     /// \param stylesheet 
     /// Input the XSL stylesheet with transformation instructions.
+    /// 
+    XslTransformer(NAMESPACE_OSGEO_COMMON_XML::XmlReader* inDoc, NAMESPACE_OSGEO_COMMON_XML::XmlReader* stylesheet);
+
+    /// \brief
+    /// Constructs an XSL Transformer object.
+    /// 
+    /// \param inDoc 
+    /// Input the XML document to transform.
+    /// \param stylesheet 
+    /// Input the XSL stylesheet with transformation instructions.
     /// \param outDoc 
     /// Output the transformed XML document.
     /// <p><b>Note:</b> The transformed document is not completely written until 'outDoc'
     /// and this transformer are destroyed by releasing all references to them.
     /// Therefore, these objects must be destroyed before reading back the 
     /// transformed document.
+    /// 
+	XslTransformer(NAMESPACE_OSGEO_COMMON_XML::XmlReader* inDoc, NAMESPACE_OSGEO_COMMON_XML::XmlReader* stylesheet, NAMESPACE_OSGEO_COMMON_XML::XmlWriter* outDoc);
+
+    /// \brief
+    /// Constructs an XSL Transformer object.
+    /// 
+    /// \param inDoc 
+    /// Input the XML document to transform.
+    /// \param stylesheet 
+    /// Input the XSL stylesheet with transformation instructions.
+    /// \param outDoc 
+    /// Output the transformed XML document.
+    /// <p><b>Note:</b> The transformed document is not completely written until 'outDoc'
+    /// and this transformer are destroyed by releasing all references to them.
+    /// Therefore, these objects must be destroyed before reading back the 
+    /// transformed document.
     /// \param log 
     /// Input the logging object.
     /// 
-	XslTransformer();
-	XslTransformer(NAMESPACE_OSGEO_COMMON_XML::XmlReader* inDoc);
-	XslTransformer(NAMESPACE_OSGEO_COMMON_XML::XmlReader* inDoc, NAMESPACE_OSGEO_COMMON_XML::XmlReader* stylesheet);
-	XslTransformer(NAMESPACE_OSGEO_COMMON_XML::XmlReader* inDoc, NAMESPACE_OSGEO_COMMON_XML::XmlReader* stylesheet, NAMESPACE_OSGEO_COMMON_XML::XmlWriter* outDoc);
     XslTransformer(NAMESPACE_OSGEO_COMMON_XML::XmlReader* inDoc, NAMESPACE_OSGEO_COMMON_XML::XmlReader* stylesheet, NAMESPACE_OSGEO_COMMON_XML::XmlWriter* outDoc, NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* log);
 
     /// \brief
@@ -76,7 +111,7 @@
     /// \param inDoc 
     /// Input the XML document to transform.
     /// 
-	__property System::Void set_InDoc(NAMESPACE_OSGEO_COMMON_XML::XmlReader* value );
+	__property System::Void set_InDoc(NAMESPACE_OSGEO_COMMON_XML::XmlReader* inDoc );
 
     /// \brief
     /// Gets the XSL Stylesheet
@@ -92,7 +127,7 @@
     /// \param stylesheet 
     /// Input the stylesheet
     /// 
-	__property System::Void set_Stylesheet(NAMESPACE_OSGEO_COMMON_XML::XmlReader* value);
+	__property System::Void set_Stylesheet(NAMESPACE_OSGEO_COMMON_XML::XmlReader* stylesheet);
 
     /// \brief
     /// Gets the output document.
@@ -110,7 +145,7 @@
     /// <p><b>Note:</b> The output document is not completely written until outDoc
     /// and this transformer are destroyed by releasing all references to them.
     /// 
-	__property System::Void set_OutDoc(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* value);
+	__property System::Void set_OutDoc(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* outDoc);
 
     /// \brief
     /// Gets the input logging object.
@@ -126,7 +161,7 @@
     /// \param outDoc 
     /// Input the logging object
     /// 
-	__property System::Void set_Log(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* value);
+	__property System::Void set_Log(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* outDoc);
 
     /// \brief
     /// Gets the list of parameters that will be passed to the 

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionary.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionary.h	2007-02-07 21:26:44 UTC (rev 731)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionary.h	2007-02-07 21:28:04 UTC (rev 732)
@@ -243,7 +243,7 @@
     /// \brief
     ///     Determines whether the collection contains a specific DictionaryElement object.
     /// 
-    /// \param value 
+    /// \param name 
     ///     Input The name of the DictionaryElement object to find in the collection.
     /// 
     /// \return
@@ -257,10 +257,10 @@
     /// \param array 
     ///     Output the one-dimensional Array that is the destination of the elements copied from this collection.
     ///
-    /// \param size 
+    /// \param index 
     ///     Input an integer that represents the index in array at which copying begins.
     /// 
-	System::Void CopyTo(DictionaryElement* array[],System::Int32 size);
+	System::Void CopyTo(DictionaryElement* array[],System::Int32 index);
 
     /// \brief
     ///     Gets a DictionaryElement in the collection.

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgException.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgException.h	2007-02-07 21:26:44 UTC (rev 731)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgException.h	2007-02-07 21:28:04 UTC (rev 732)
@@ -22,6 +22,9 @@
 
 BEGIN_NAMESPACE_OSGEO_COMMON
 
+/// \brief
+/// Exception is a root class for the exception type thrown from classes. It derives from a language 
+/// level exception class that is environment specific.
 [System::SerializableAttribute]
 public __gc class Exception : public System::Exception
 {
@@ -46,12 +49,9 @@
     /// \brief
     /// Creates an instance of an Exception using the specified arguments.
     /// 
-    /// \param message 
+    /// \param msg 
     /// Input the error message
     /// 
-    /// \return
-    /// Returns the newly created Exception object
-    /// 
 	NAMESPACE_OSGEO_COMMON::Exception(String* msg) : System::Exception(msg)
 	{
 		
@@ -60,15 +60,12 @@
     /// \brief
     ///  Returns an instance of a Exception using the specified arguments.
     /// 
-    /// \param message 
+    /// \param msg 
     /// Input the error message
     ///
     /// \param cause 
     /// Input the cause of the error
     /// 
-    /// \return
-    /// Returns the Exception object
-    /// 
 	NAMESPACE_OSGEO_COMMON::Exception(System::String* msg, System::Exception* cause) : System::Exception(msg, cause)
 	{
 		

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgStringCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgStringCollection.h	2007-02-07 21:26:44 UTC (rev 731)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgStringCollection.h	2007-02-07 21:28:04 UTC (rev 732)
@@ -139,7 +139,7 @@
     /// \brief
     ///     Creates a copy of string collection
     /// 
-    /// \param src 
+    /// \param collection 
     ///     Input the source collection
     /// 
 	StringCollection(StringCollection* collection);
@@ -166,7 +166,7 @@
     /// \param delimiters 
     ///     Input list of single character token delimiters.
     ///
-    /// \param bNullTokens 
+    /// \param nullTokens 
     ///     true: include zero-length tokens in the collection.
     ///     false: exclude zero-length tokens
     /// 
@@ -227,10 +227,10 @@
     /// \brief
     ///     Appends the strings from src to the end of this collection.
     /// 
-    /// \param src 
+    /// \param collection 
     ///     Input the source collection
     /// 
-	System::Void Append(StringCollection* col);
+	System::Void Append(StringCollection* collection);
 
     /// \brief
     ///     Gets a String in the collection.
@@ -290,10 +290,10 @@
     /// \param array 
     ///     Output the one-dimensional Array that is the destination of the elements copied from this collection.
     ///
-    /// \param startAt 
+    /// \param index 
     ///     Input an integer that represents the index in array at which copying begins.
     /// 
-	System::Void CopyTo(StringElement* array[],System::Int32 size);
+	System::Void CopyTo(StringElement* array[],System::Int32 index);
 
     /// \brief
     ///     Gets a StringElement in the collection.



More information about the fdo-commits mailing list