Modify api documentation
[platform/core/csapi/tizenfx.git] / src / Tizen.Location / Tizen.Location / GpsSatellite.cs
index f32db04..da40e85 100755 (executable)
@@ -37,8 +37,8 @@ namespace Tizen.Location
         /// The time interval between callback updates.
         /// Should be in the range [1~120] seconds.
         /// </summary>
-        /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
-        /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+        /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+        /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
         public int Interval
         {
             get
@@ -64,10 +64,10 @@ namespace Tizen.Location
         /// <summary>
         /// The NMEAData from the Satellite.
         /// </summary>
-        /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
-        /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
-        /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
-        /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+        /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+        /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+        /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+        /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
         public string Nmea
         {
             get
@@ -94,10 +94,11 @@ namespace Tizen.Location
         /// <summary>
         /// The Count of Active satellites.
         /// </summary>
-        /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
-        /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
-        /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
-        /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+        /// <privilege>http://tizen.org/privilege/location</privilege>
+        /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+        /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+        /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+        /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
         public int ActiveCount
         {
             get
@@ -124,10 +125,11 @@ namespace Tizen.Location
         /// <summary>
         /// The Count of satellites in view.
         /// </summary>
-        /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
-        /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
-        /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
-        /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+        /// <privilege>http://tizen.org/privilege/location</privilege>
+        /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+        /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+        /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+        /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
         public int InViewCount
         {
             get
@@ -154,10 +156,11 @@ namespace Tizen.Location
         /// <summary>
         /// The list of satellites/last recorded satellites in view.
         /// </summary>
-        /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
-        /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
-        /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
-        /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+        /// <privilege>http://tizen.org/privilege/location</privilege>
+        /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+        /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+        /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+        /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
         public IList<SatelliteInformation> Satellites
         {
             get
@@ -192,9 +195,9 @@ namespace Tizen.Location
 
         /// <summary>
         /// The constructor of GpsSatellite class.
-        /// <param name="locator"> Locator object initilized using Gps.</param>
         /// </summary>
-        /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
+        /// <param name="locator"> Locator object initilized using Gps.</param>
+        /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
         public GpsSatellite(Locator locator)
         {
             Log.Info(Globals.LogTag, "Calling GpsSatellite constructor");
@@ -221,9 +224,10 @@ namespace Tizen.Location
         /// (event) SatelliteStatusUpdated is raised whenever satellite information is updated.
         /// The callback will be invoked periodically (every Interval seconds).
         /// </summary>
-        /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
-        /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
-        /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+        /// <privilege>http://tizen.org/privilege/location</privilege>
+        /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+        /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+        /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
         public event EventHandler<SatelliteStatusChangedEventArgs> SatelliteStatusUpdated
         {
             add