Add code documentation to FileGdbProvider

FObermaier · FObermaier · commit 6cd7368b792e · 2020-10-06T11:24:58.000+02:00
diff --git a/SharpMap.Data.Providers.FileGdb/FileGdbProvider.cs b/SharpMap.Data.Providers.FileGdb/FileGdbProvider.cs
@@ -29,6 +29,9 @@
 
 namespace SharpMap.Data.Providers
 {
+    /// <summary>
+    /// Provider implementation for ESRI File Gdb database
+    /// </summary>
     [Serializable]
     public class FileGdbProvider : IProvider
     {
@@ -73,10 +76,17 @@ private EsriGdb EsriGdbInstance
         [NonSerialized]
         private EsriTable _esriTable;
 
+        /// <summary>
+        /// Creates an instance of this class
+        /// </summary>
         public FileGdbProvider()
         {
         }
 
+        /// <summary>
+        /// Creates an instance of this class, assigning the location of the database
+        /// </summary>
+        /// <param name="path">A path to the directory containing the database files.</param>
         public FileGdbProvider(string path)
         {
             _esriGdbLocation = new DirectoryInfo(path);
@@ -93,6 +103,10 @@ public void Dispose()
             Dispose(true);
         }
 
+        /// <summary>
+        /// Actual implementation for disposing the provider.
+        /// </summary>
+        /// <param name="disposing">A flag indicating if this function is called from <see cref="IDisposable.Dispose()"/> or the finalizer.</param>
         protected virtual void Dispose(bool disposing)
         {
             if (IsDisposed)
@@ -110,6 +124,9 @@ protected virtual void Dispose(bool disposing)
             }
         }
 
+        /// <summary>
+        /// Gets a value indicating if this provider has been disposed.
+        /// </summary>
         public bool IsDisposed { get; private set; }
 
         #endregion
@@ -136,6 +153,10 @@ public string ConnectionID
         }
 
         private string _table;
+
+        /// <summary>
+        /// Gets or sets a value indicating the name of the data table.
+        /// </summary>
         public string Table
         {
             get { return _table; }
@@ -191,11 +212,11 @@ public Collection<IGeometry> GetGeometriesInView(Envelope bbox)
         }
 
         /// <summary>
-        /// Returns all objects whose <see cref="SharpMap.Geometries.BoundingBox"/> intersects 'bbox'.
+        /// Returns all objects whose <see cref="Envelope"/> intersects 'bbox'.
         /// </summary>
         /// <remarks>
         /// This method is usually much faster than the QueryFeatures method, because intersection tests
-        /// are performed on objects simplifed by their <see cref="SharpMap.Geometries.BoundingBox"/>, and using the Spatial Index
+        /// are performed on objects simplified by their <see cref="Envelope"/>, and using the Spatial Index
         /// </remarks>
         /// <param name="bbox">Box that objects should intersect</param>
         /// <returns></returns>
@@ -400,18 +421,33 @@ public void Close()
             //Nothing to do
         }
 
+        /// <summary>
+        /// Gets an array of feature dataset names
+        /// </summary>
+        /// <param name="path">The root path (default = "\")</param>
+        /// <returns>An array of feature dataset names.</returns>
         public string[] GetFeatureDatasets(string path = "\\")
         {
             var e = EsriGdbInstance;
             return e.GetChildDatasets(path, "Feature Dataset");
         }
 
+        /// <summary>
+        /// Gets an array of feature class names
+        /// </summary>
+        /// <param name="path">The root path (default = "\")</param>
+        /// <returns>An array of feature class names.</returns>
         public string[] GetFeatureClasses(string path = "\\")
         {
             var e = EsriGdbInstance;
             return e.GetChildDatasets(path, "Feature Class");
         }
 
+        /// <summary>
+        /// Gets an array of table names
+        /// </summary>
+        /// <param name="path">The root path (default = "\")</param>
+        /// <returns>An array of table names.</returns>
         public string[] GetTables(string path = "\\")
         {
             var e = EsriGdbInstance;
@@ -420,6 +456,7 @@ public string[] GetTables(string path = "\\")
 
         #endregion
 #if DEBUG
+#pragma warning disable 1591
         public IEnumerable<string> EnumerateTables(string path = "\\")
         {
             var e = EsriGdbInstance;
@@ -437,11 +474,9 @@ public IEnumerable<string> EnumerateTables(string path = "\\")
                 }
             }
         }
+#pragma warning restore 1591
 #endif
     }
 
-#if DEBUG
-
-#endif
 
 }
diff --git a/SharpMap.Data.Providers.FileGdb/FileGdbProviderTest.cs b/SharpMap.Data.Providers.FileGdb/FileGdbProviderTest.cs
@@ -26,6 +26,8 @@
 using NUnit.Framework;
 using SharpMap.Layers;
 
+#pragma warning disable 1591
+
 namespace SharpMap.Data.Providers
 {
 

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,9 @@`
`29`	`29`
`30`	`30`	`namespace SharpMap.Data.Providers`
`31`	`31`	`{`
	`32`	`+ /// <summary>`
	`33`	`+ /// Provider implementation for ESRI File Gdb database`
	`34`	`+ /// </summary>`
`32`	`35`	`[Serializable]`
`33`	`36`	`public class FileGdbProvider : IProvider`
`34`	`37`	`{`
`@@ -73,10 +76,17 @@ private EsriGdb EsriGdbInstance`
`73`	`76`	`[NonSerialized]`
`74`	`77`	`private EsriTable _esriTable;`
`75`	`78`
	`79`	`+ /// <summary>`
	`80`	`+ /// Creates an instance of this class`
	`81`	`+ /// </summary>`
`76`	`82`	`public FileGdbProvider()`
`77`	`83`	`{`
`78`	`84`	`}`
`79`	`85`
	`86`	`+ /// <summary>`
	`87`	`+ /// Creates an instance of this class, assigning the location of the database`
	`88`	`+ /// </summary>`
	`89`	`+ /// <param name="path">A path to the directory containing the database files.</param>`
`80`	`90`	`public FileGdbProvider(string path)`
`81`	`91`	`{`
`82`	`92`	`_esriGdbLocation = new DirectoryInfo(path);`
`@@ -93,6 +103,10 @@ public void Dispose()`
`93`	`103`	`Dispose(true);`
`94`	`104`	`}`
`95`	`105`
	`106`	`+ /// <summary>`
	`107`	`+ /// Actual implementation for disposing the provider.`
	`108`	`+ /// </summary>`
	`109`	`+ /// <param name="disposing">A flag indicating if this function is called from <see cref="IDisposable.Dispose()"/> or the finalizer.</param>`
`96`	`110`	`protected virtual void Dispose(bool disposing)`
`97`	`111`	`{`
`98`	`112`	`if (IsDisposed)`
`@@ -110,6 +124,9 @@ protected virtual void Dispose(bool disposing)`
`110`	`124`	`}`
`111`	`125`	`}`
`112`	`126`
	`127`	`+ /// <summary>`
	`128`	`+ /// Gets a value indicating if this provider has been disposed.`
	`129`	`+ /// </summary>`
`113`	`130`	`public bool IsDisposed { get; private set; }`
`114`	`131`
`115`	`132`	`#endregion`
`@@ -136,6 +153,10 @@ public string ConnectionID`
`136`	`153`	`}`
`137`	`154`
`138`	`155`	`private string _table;`
	`156`	`+`
	`157`	`+ /// <summary>`
	`158`	`+ /// Gets or sets a value indicating the name of the data table.`
	`159`	`+ /// </summary>`
`139`	`160`	`public string Table`
`140`	`161`	`{`
`141`	`162`	`get { return _table; }`
`@@ -191,11 +212,11 @@ public Collection<IGeometry> GetGeometriesInView(Envelope bbox)`
`191`	`212`	`}`
`192`	`213`
`193`	`214`	`/// <summary>`
`194`		`- /// Returns all objects whose <see cref="SharpMap.Geometries.BoundingBox"/> intersects 'bbox'.`
	`215`	`+ /// Returns all objects whose <see cref="Envelope"/> intersects 'bbox'.`
`195`	`216`	`/// </summary>`
`196`	`217`	`/// <remarks>`
`197`	`218`	`/// This method is usually much faster than the QueryFeatures method, because intersection tests`
`198`		`- /// are performed on objects simplifed by their <see cref="SharpMap.Geometries.BoundingBox"/>, and using the Spatial Index`
	`219`	`+ /// are performed on objects simplified by their <see cref="Envelope"/>, and using the Spatial Index`
`199`	`220`	`/// </remarks>`
`200`	`221`	`/// <param name="bbox">Box that objects should intersect</param>`
`201`	`222`	`/// <returns></returns>`
`@@ -400,18 +421,33 @@ public void Close()`
`400`	`421`	`//Nothing to do`
`401`	`422`	`}`
`402`	`423`
	`424`	`+ /// <summary>`
	`425`	`+ /// Gets an array of feature dataset names`
	`426`	`+ /// </summary>`
	`427`	`+ /// <param name="path">The root path (default = "\")</param>`
	`428`	`+ /// <returns>An array of feature dataset names.</returns>`
`403`	`429`	`public string[] GetFeatureDatasets(string path = "\\")`
`404`	`430`	`{`
`405`	`431`	`var e = EsriGdbInstance;`
`406`	`432`	`return e.GetChildDatasets(path, "Feature Dataset");`
`407`	`433`	`}`
`408`	`434`
	`435`	`+ /// <summary>`
	`436`	`+ /// Gets an array of feature class names`
	`437`	`+ /// </summary>`
	`438`	`+ /// <param name="path">The root path (default = "\")</param>`
	`439`	`+ /// <returns>An array of feature class names.</returns>`
`409`	`440`	`public string[] GetFeatureClasses(string path = "\\")`
`410`	`441`	`{`
`411`	`442`	`var e = EsriGdbInstance;`
`412`	`443`	`return e.GetChildDatasets(path, "Feature Class");`
`413`	`444`	`}`
`414`	`445`
	`446`	`+ /// <summary>`
	`447`	`+ /// Gets an array of table names`
	`448`	`+ /// </summary>`
	`449`	`+ /// <param name="path">The root path (default = "\")</param>`
	`450`	`+ /// <returns>An array of table names.</returns>`
`415`	`451`	`public string[] GetTables(string path = "\\")`
`416`	`452`	`{`
`417`	`453`	`var e = EsriGdbInstance;`
`@@ -420,6 +456,7 @@ public string[] GetTables(string path = "\\")`
`420`	`456`
`421`	`457`	`#endregion`
`422`	`458`	`#if DEBUG`
	`459`	`+#pragma warning disable 1591`
`423`	`460`	`public IEnumerable<string> EnumerateTables(string path = "\\")`
`424`	`461`	`{`
`425`	`462`	`var e = EsriGdbInstance;`
`@@ -437,11 +474,9 @@ public IEnumerable<string> EnumerateTables(string path = "\\")`
`437`	`474`	`}`
`438`	`475`	`}`
`439`	`476`	`}`
	`477`	`+#pragma warning restore 1591`
`440`	`478`	`#endif`
`441`	`479`	`}`
`442`	`480`
`443`		`-#if DEBUG`
`444`		`-`
`445`		`-#endif`
`446`	`481`
`447`	`482`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,8 @@`
`26`	`26`	`using NUnit.Framework;`
`27`	`27`	`using SharpMap.Layers;`
`28`	`28`
	`29`	`+#pragma warning disable 1591`
	`30`	`+`
`29`	`31`	`namespace SharpMap.Data.Providers`
`30`	`32`	`{`
`31`	`33`