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

svn_fdo at osgeo.org svn_fdo at osgeo.org
Thu Feb 1 19:11:32 EST 2007


Author: gregboone
Date: 2007-02-01 19:11:31 -0500 (Thu, 01 Feb 2007)
New Revision: 703

Modified:
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttributeCollection.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSaxContext.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionary.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/Xml/mgXmlAttributeCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttributeCollection.h	2007-02-02 00:09:07 UTC (rev 702)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlAttributeCollection.h	2007-02-02 00:11:31 UTC (rev 703)
@@ -27,14 +27,32 @@
 public __gc class XmlAttribute;
 
 /// \brief
-///     XmlAttributeCollection is a collection of name-value pairs.
+/// The XmlAttributeCollection class represents a collection of XmlAttribute objects.
 [System::Reflection::DefaultMemberAttribute("RealTypeItem")]
 public __sealed __gc class XmlAttributeCollection : public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
 {
 /// \cond DOXYGEN-IGNORE
 private:
     /// \brief
-    /// nested class defined to provide Enumerator.
+    /// 	A Nested class defined to provide enumeration of Dictionary elements
+    ///
+    ///     Enumerators can be used to read the data in the collection, 
+    ///     but they cannot be used to modify the underlying collection.
+    ///
+    ///     An enumerator remains valid as long as the collection remains unchanged. 
+    ///     If changes are made to the collection, such as adding, modifying, or deleting 
+    ///     elements, the enumerator is irrecoverably invalidated and the next call to 
+    ///     MoveNext or Reset throws an InvalidOperationException. If the collection is 
+    ///     modified between MoveNext and Current, Current returns the element that it is 
+    ///     set to, even if the enumerator is already invalidated.
+    ///
+    ///     The enumerator does not have exclusive access to the collection; therefore, 
+    ///     enumerating through a collection is intrinsically not a thread-safe procedure. 
+    ///     Even when a collection is synchronized, other threads can still modify the 
+    ///     collection, which causes the enumerator to throw an exception. To guarantee 
+    ///     thread safety during enumeration, you can either lock the collection during 
+    ///     the entire enumeration or catch the exceptions resulting from changes made 
+    ///     by other threads.
     /// 
 	__gc class Enumerator : public System::Collections::IEnumerator
 	{
@@ -93,31 +111,25 @@
 	virtual System::Void ReleaseUnmanagedObject();
 
 private:
-    // System::Collections::ICollection interfaces
-	System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
+    // System::Collections::ICollection interface properties
+    __property System::Object* System::Collections::ICollection::get_SyncRoot();
+    __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
 
-	__property System::Object* System::Collections::ICollection::get_SyncRoot();
+    // System::Collections::ICollection interface methods
+    System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
 
-	__property System::Boolean System::Collections::ICollection::get_IsSynchronized();
+    // System::Collections::IList interface properties
+    __property System::Boolean System::Collections::IList::get_IsFixedSize();
+    __property System::Boolean System::Collections::IList::get_IsReadOnly();
+    __property Object* System::Collections::IList::get_Item(System::Int32 index);
+    __property System::Void  System::Collections::IList::set_Item(System::Int32 index, Object* value);
 
-    // System::Collections::IList interfaces
-	__property System::Boolean System::Collections::IList::get_IsFixedSize();
-
-	__property System::Boolean System::Collections::IList::get_IsReadOnly();
-
-	System::Int32 System::Collections::IList::Add(Object* value);
-
-	System::Boolean System::Collections::IList::Contains(Object* value);
-
-	System::Int32 System::Collections::IList::IndexOf(Object* value);
-
-	System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
-
-	System::Void System::Collections::IList::Remove(Object* value);
-
-	__property Object* System::Collections::IList::get_Item(System::Int32 index);
-
-	__property System::Void  System::Collections::IList::set_Item(System::Int32 index, Object* value);
+    // System::Collections::IList interface methods
+    System::Int32 System::Collections::IList::Add(Object* value);
+    System::Boolean System::Collections::IList::Contains(Object* value);
+    System::Int32 System::Collections::IList::IndexOf(Object* value);
+    System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
+    System::Void System::Collections::IList::Remove(Object* value);
 /// \endcond
 
 public:
@@ -141,11 +153,17 @@
     /// \brief
     ///    Gets the count of items in collection.
     /// 
+    /// \return
+    /// 	Returns the number of items in the collection.
+    /// 
 	__property System::Int32 get_Count(System::Void);
 
     /// \brief
     ///    Gets an enumerator that can iterate through a collection.
     /// 
+    /// \return
+    /// 	Returns an enumerator on the collection.
+    /// 
 	__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
 
     /// \brief

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSaxContext.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSaxContext.h	2007-02-02 00:09:07 UTC (rev 702)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/Xml/mgXmlSaxContext.h	2007-02-02 00:11:31 UTC (rev 703)
@@ -55,7 +55,7 @@
 	__property NAMESPACE_OSGEO_COMMON_XML::XmlReader* get_Reader();
 
     /// \brief
-    /// Constructs an XmlSaxContext obhject based on an unmanaged instance of the object
+    /// Constructs an XmlSaxContext object based on an unmanaged instance of the object
     /// 
     /// \param unmanaged 
     /// Input A Pointer to the unmanaged object.

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-02 00:09:07 UTC (rev 702)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgDictionary.h	2007-02-02 00:11:31 UTC (rev 703)
@@ -26,8 +26,7 @@
 public __gc class DictionaryElement;
 
 /// \brief
-///     DictionaryElementCollection is a collection of name-value pairs.
-///
+/// DictionaryElementCollection is a collection of DictionaryElement objects(name-value pairs).
 [System::Reflection::DefaultMemberAttribute("RealTypeItem")]
 public __sealed __gc class DictionaryElementCollection : 
     public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
@@ -109,31 +108,26 @@
 	inline FdoDictionary* GetImpObj();
 
 private:
-    // System::Collections::ICollection interfaces
-	System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
+    // System::Collections::ICollection interface properties
+    __property System::Object* System::Collections::ICollection::get_SyncRoot();
+    __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
 
-	__property System::Object* System::Collections::ICollection::get_SyncRoot();
+    // System::Collections::ICollection interface methods
+    System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
 
-	__property System::Boolean System::Collections::ICollection::get_IsSynchronized();
+    // System::Collections::IList interface properties
+    __property System::Boolean System::Collections::IList::get_IsFixedSize();
+    __property System::Boolean System::Collections::IList::get_IsReadOnly();
+    __property Object* System::Collections::IList::get_Item(System::Int32 index);
+    __property System::Void  System::Collections::IList::set_Item(System::Int32 index, Object* value);
 
-    // System::Collections::IList interfaces
-	__property System::Boolean System::Collections::IList::get_IsFixedSize();
+    // System::Collections::IList interface methods
+    System::Int32 System::Collections::IList::Add(Object* value);
+    System::Boolean System::Collections::IList::Contains(Object* value);
+    System::Int32 System::Collections::IList::IndexOf(Object* value);
+    System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
+    System::Void System::Collections::IList::Remove(Object* value);
 
-	__property System::Boolean System::Collections::IList::get_IsReadOnly();
-
-	System::Int32 System::Collections::IList::Add(Object* value);
-
-	System::Boolean System::Collections::IList::Contains(Object* value);
-
-	System::Int32 System::Collections::IList::IndexOf(Object* value);
-
-	System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
-
-	System::Void System::Collections::IList::Remove(Object* value);
-
-	__property Object* System::Collections::IList::get_Item(System::Int32 index);
-
-	__property System::Void  System::Collections::IList::set_Item(System::Int32 index, Object* value);
 /// \endcond
 
 public:

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-02 00:09:07 UTC (rev 702)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Common/mgStringCollection.h	2007-02-02 00:11:31 UTC (rev 703)
@@ -33,7 +33,25 @@
 /// \cond DOXYGEN-IGNORE
 private:
     /// \brief
-    ///     nested class defined to provide Enumerator.
+    /// 	A Nested class defined to provide enumeration of Dictionary elements
+    ///
+    ///     Enumerators can be used to read the data in the collection, 
+    ///     but they cannot be used to modify the underlying collection.
+    ///
+    ///     An enumerator remains valid as long as the collection remains unchanged. 
+    ///     If changes are made to the collection, such as adding, modifying, or deleting 
+    ///     elements, the enumerator is irrecoverably invalidated and the next call to 
+    ///     MoveNext or Reset throws an InvalidOperationException. If the collection is 
+    ///     modified between MoveNext and Current, Current returns the element that it is 
+    ///     set to, even if the enumerator is already invalidated.
+    ///
+    ///     The enumerator does not have exclusive access to the collection; therefore, 
+    ///     enumerating through a collection is intrinsically not a thread-safe procedure. 
+    ///     Even when a collection is synchronized, other threads can still modify the 
+    ///     collection, which causes the enumerator to throw an exception. To guarantee 
+    ///     thread safety during enumeration, you can either lock the collection during 
+    ///     the entire enumeration or catch the exceptions resulting from changes made 
+    ///     by other threads.
     /// 
 	__gc class Enumerator : public System::Collections::IEnumerator
 	{
@@ -90,31 +108,26 @@
 	inline FdoStringCollection* GetImpObj();
 
 private:
-    // System::Collections::ICollection interfaces
-	System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
+    // System::Collections::ICollection interface properties
+    __property System::Object* System::Collections::ICollection::get_SyncRoot();
+    __property System::Boolean System::Collections::ICollection::get_IsSynchronized();
 
-	__property System::Object* System::Collections::ICollection::get_SyncRoot();
+    // System::Collections::ICollection interface methods
+    System::Void System::Collections::ICollection::CopyTo(System::Array* array,System::Int32 index);
 
-	__property System::Boolean System::Collections::ICollection::get_IsSynchronized();
+    // System::Collections::IList interface properties
+    __property System::Boolean System::Collections::IList::get_IsFixedSize();
+    __property System::Boolean System::Collections::IList::get_IsReadOnly();
+    __property Object* System::Collections::IList::get_Item(System::Int32 index);
+    __property System::Void  System::Collections::IList::set_Item(System::Int32 index, Object* value);
 
-    // System::Collections::IList interfaces
-	__property System::Boolean System::Collections::IList::get_IsFixedSize();
+    // System::Collections::IList interface methods
+    System::Int32 System::Collections::IList::Add(Object* value);
+    System::Boolean System::Collections::IList::Contains(Object* value);
+    System::Int32 System::Collections::IList::IndexOf(Object* value);
+    System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
+    System::Void System::Collections::IList::Remove(Object* value);
 
-	__property System::Boolean System::Collections::IList::get_IsReadOnly();
-
-	System::Int32 System::Collections::IList::Add(Object* value);
-
-	System::Boolean System::Collections::IList::Contains(Object* value);
-
-	System::Int32 System::Collections::IList::IndexOf(Object* value);
-
-	System::Void System::Collections::IList::Insert(System::Int32 index, Object* value);
-
-	System::Void System::Collections::IList::Remove(Object* value);
-
-	__property Object* System::Collections::IList::get_Item(System::Int32 index);
-
-	__property System::Void  System::Collections::IList::set_Item(System::Int32 index, Object* value);
 /// \endcond
 
 public:



More information about the fdo-commits mailing list