[MachineLearning.Train] Add exception to doxygen
authorhyunil park <hyunil46.park@samsung.com>
Thu, 18 Aug 2022 02:24:36 +0000 (11:24 +0900)
committerJijoong Moon <jijoong.moon@samsung.com>
Tue, 23 Aug 2022 05:50:26 +0000 (14:50 +0900)
- Add NotSupported, Argument and InvalidOperation Exception to all class doxygen
- Add UnauthorizedAccess Exception to Model and Dataset class doxygen

Signed-off-by: hyunil park <hyunil46.park@samsung.com>
src/Tizen.MachineLearning.Train/Tizen.MachineLearning.Train/Dataset.cs
src/Tizen.MachineLearning.Train/Tizen.MachineLearning.Train/Layer.cs
src/Tizen.MachineLearning.Train/Tizen.MachineLearning.Train/Model.cs
src/Tizen.MachineLearning.Train/Tizen.MachineLearning.Train/Optimizer.cs

index 25747ad..3a4c919 100644 (file)
@@ -26,6 +26,10 @@ namespace Tizen.MachineLearning.Train
     /// Use this class to create a dataset. dataset should be released using Dispose().
     /// dataset is available until the model is released.
     /// </remarks>
+    /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+    /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+    /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have the required privilege.</exception>
+    /// <exception cref="InvalidOperationException">Thrown when the method failed due to the wrong pipeline description or internal error.</exception>
     /// <since_tizen> 10 </since_tizen>
     public class Dataset: IDisposable
     {
index a34c17f..9b04058 100644 (file)
@@ -28,6 +28,9 @@ namespace Tizen.MachineLearning.Train
     /// If added to a model by AddLayer method of Model, layer is available until the model is released. so
     /// Dispose() must never be used.
     /// </remarks>
+    /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+    /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+    /// <exception cref="InvalidOperationException">Thrown when the method failed due to the wrong pipeline description or internal error.</exception>
     /// <since_tizen> 10 </since_tizen>
     public class Layer: IDisposable
     {
index cfb1106..9e6d54b 100644 (file)
@@ -32,6 +32,10 @@ namespace Tizen.MachineLearning.Train
     /// privilege %http://tizen.org/privilege/externalstorage. If you want to access
     /// both storage, you must add all the privileges.
     /// </remarks>
+    /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+    /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+    /// <exception cref="UnauthorizedAccessException">Thrown when the application does not have the required privilege.</exception>
+    /// <exception cref="InvalidOperationException">Thrown when the method failed due to the wrong pipeline description or internal error.</exception>
     /// <since_tizen> 10 </since_tizen>
     public class Model: IDisposable
     {
index abc2a14..90dd049 100644 (file)
@@ -27,6 +27,9 @@ namespace Tizen.MachineLearning.Train
     /// model, optimizer should be released using Dispose().
     /// If set to a model, optimizer is available until model is released.
     /// </remarks>
+    /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
+    /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+    /// <exception cref="InvalidOperationException">Thrown when the method failed due to the wrong pipeline description or internal error.</exception>
     /// <since_tizen> 10 </since_tizen>
     public class Optimizer: IDisposable
     {