Fix xml documentation issues (#105)
authorwiertel <wiertel@users.sourceforge.net>
Wed, 31 Jan 2018 10:08:08 +0000 (11:08 +0100)
committerWonYoung Choi <wy80.choi@samsung.com>
Wed, 31 Jan 2018 10:08:08 +0000 (19:08 +0900)
3 cases of invalid xml structure
<description> added to list items
2 cases of < character - replaced with &lt;

src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSlider.cs
src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountService.cs
src/Tizen.Content.MediaContent/doc/api/Tizen.Content.MediaContent.md
src/Tizen.Location.Geofence/Tizen.Location.Geofence/Fence.cs
src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceStatus.cs
src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceManager.cs
src/Tizen.NUI/src/public/NUIConstants.cs
src/Tizen.NUI/src/public/VisualMaps.cs
src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsDatabase.cs
src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsRecord.cs

index a568a35f82728cc3df3805f55c96fc042f91c8a8..7a071dd33db2e7c2fa17cad07701fb93c2354533 100755 (executable)
@@ -416,7 +416,7 @@ namespace ElmSharp.Wearable
         /// <summary>
         /// Creates a widget handle.
         /// </summary>
-        /// <param name="parent">Parent EvasObject.param>
+        /// <param name="parent">Parent EvasObject</param>
         /// <returns>Handle IntPtr.</returns>
         /// <since_tizen> preview </since_tizen>
         protected override IntPtr CreateHandle(EvasObject parent)
index 9e5193ca384cc761a5c18f4602b6e398be0c738c..88b0428436025992fa6a50e72018ab5e32431678 100644 (file)
@@ -25,11 +25,11 @@ namespace Tizen.Account.AccountManager
     /// 2. Adding an account information when an application signs in successfully to share the account information to the Tizen system. This information will be shown in the Tizen settings account menu.
     ///
     /// The APIs of both of the sections consist of the following functionality:
-    /// <list>
-    /// <item> Create an account or account provider.</item>
-    /// <item> Update an account or account provider (Only available for the creator).</item>
-    /// <item> Delete an account or account provider (Only available for the creator).</item>
-    /// <item> Read an account or account provider with some filter.</item>
+    /// <list type="bullet">
+    /// <item><description>Create an account or account provider.</description></item>
+    /// <item><description>Update an account or account provider (Only available for the creator).</description></item>
+    /// <item><description>Delete an account or account provider (Only available for the creator).</description></item>
+    /// <item><description>Read an account or account provider with some filter.</description></item>
     /// </list>
     /// </summary>
     /// <since_tizen> 3 </since_tizen>
index c85b717118db0330288e0d7387a20272fecdab86..e5e8d0de3694aa061e0e56581e4424c6d2a2c460 100644 (file)
 # limitations under the License.
 
 uid: Tizen.Content.MediaContent
-summary: *content
-remarks: The media content service does not manage hidden files.
-In addition, if "http://tizen.org/feature/content.scanning.others" feature is not supported,
-other-type files which are not included in the media content types such as image, video, sound or music, are ignored.
+summary: The Tizen.Content.MediaContent namespace provides types used in the entire content service.
+remarks: *content
 ---
-The Tizen.Content.MediaContent namespace provides types used in the entire content service.
 The information about media items (i.e. image, audio, and video) are managed in the content database
 and operations that involve database require an active connection with the media content service.
 During media scanning, the media content service extracts the media information automatically. The media information
 includes basic file information like path, size, modified time, etc. and some metadata like ID3 tag, EXIF,
 thumbnail, etc. (thumbnail extracted only in the internal and the SD card storage.
+
+The media content service does not manage hidden files.
+
+In addition, if "http://tizen.org/feature/content.scanning.others" feature is not supported,
+other-type files which are not included in the media content types such as image, video, sound or music, are ignored.
index f310bd7cd8eb4173ccce468d5fbc62147a866898..60ae5834b0f1bbe4e70bb04e821a4727e98c56a7 100755 (executable)
@@ -22,10 +22,10 @@ namespace Tizen.Location.Geofence
     /// Geofence defines a virtual perimeter for a real-world geographic area.
     /// If you create a geofence, you can trigger some activities when a device enters (or exits) the geofences defined by you.
     /// You can create a geofence with the information of the Geopoint, Wi-Fi, or BT.
-    /// <list>
-    /// <item>Geopoint: Geofence is specified by the coordinates (Latitude and Longitude) and radius.</item>
-    /// <item>WIFI: Geofence is specified by the BSSID of the Wi-Fi access point.</item>
-    /// <item>BT: Geofence is specified by the Bluetooth address.</item>
+    /// <list type="bullet">
+    /// <item><description>Geopoint: Geofence is specified by the coordinates (Latitude and Longitude) and radius.</description></item>
+    /// <item><description>WIFI: Geofence is specified by the BSSID of the Wi-Fi access point.</description></item>
+    /// <item><description>BT: Geofence is specified by the Bluetooth address.</description></item>
     /// </list>
     /// The Basic service set identifier (BSSID) is the MAC address of the wireless access point (WAP) generated by combining the 24-bit Organization Unique Identifier (the manufacturer's identity)
     /// and the manufacturer's assigned 24-bit identifier for the radio chipset in the WAP.
@@ -215,7 +215,7 @@ namespace Tizen.Location.Geofence
         /// <param name="placeId">The current place ID.</param>
         /// <param name="latitude">Specifies the value of latitude of the geofence [-90.0 ~ 90.0] \(degrees).</param>
         /// <param name="longitude">Specifies the value of longitude of the geofence [-180.0 ~ 180.0] \(degrees).</param>
-        /// <param name="radius">Specifies the value of radius of the geofence [100 ~ 500](meter).</param>
+        /// <param name="radius">Specifies the value of radius of the geofence [100 ~ 500] \(meter).</param>
         /// <param name="address">Specifies the value of the address.</param>
         /// <returns>The newly created geofence instance.</returns>
         /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
index 66e8200b829cbff9630802f66b2558bd766de5a8..23c0efb12f79d1c054775bb9d1fac063c37bcb2f 100644 (file)
@@ -20,9 +20,9 @@ namespace Tizen.Location.Geofence
 {
     /// <summary>
     /// The geofence status describes the current state and duration of a geofence.
-    /// <list>
-    /// <item>State: The state is specified by the current state of the fence.</item>
-    /// <item>Duration: Geofence is specified by the duration of the current state.</item>
+    /// <list type="bullet">
+    /// <item><description>State: The state is specified by the current state of the fence.</description></item>
+    /// <item><description>Duration: Geofence is specified by the duration of the current state.</description></item>
     /// </list>
     /// </summary>
     /// <since_tizen> 3 </since_tizen>
index f85cd7e2db1c250a1d31ec1f0f61242f0dced47a..6019721ff48d26da7feb81a58615767d45ec6032 100755 (executable)
@@ -24,15 +24,15 @@ namespace Tizen.Location.Geofence
     /// This API provides functions to set geofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address.
     /// Also, notifications on events like changing in service status are provided.
     /// There are two kinds of places and fences:
-    /// <list>
-    /// <item>Public places and fences are created by the MyPlace application that can be used by all applications.</item>
-    /// <item>Private places and fences are created by the specified application that can be used by the same application.</item>
+    /// <list type="bullet">
+    /// <item><description>Public places and fences are created by the MyPlace application that can be used by all applications.</description></item>
+    /// <item><description>Private places and fences are created by the specified application that can be used by the same application.</description></item>
     /// </list>
     /// Notifications can be received about the following events:
-    /// <list>
-    /// <item>Zone in when a device enters a specific area.</item>
-    /// <item>Zone out when a device exits a specific area.</item>
-    /// <item>Results and errors for each event requested to the geofence module.</item>
+    /// <list type="bullet">
+    /// <item><description>Zone in when a device enters a specific area.</description></item>
+    /// <item><description>Zone out when a device exits a specific area.</description></item>
+    /// <item><description>Results and errors for each event requested to the geofence module.</description></item>
     /// </list>
     /// </summary>
     /// <since_tizen> 3 </since_tizen>
index 6a5fae0614f0be08268cfe10a5857afab6950cf8..c513bc8b72f9a322c8821933b52b3a39578d284a 100755 (executable)
@@ -1261,7 +1261,7 @@ namespace Tizen.NUI
         public static readonly int FrameDelay = NDalic.IMAGE_VISUAL_FRAME_DELAY;
         /// <summary>
         /// The number of times the AnimatedImageVisual will be looped
-        /// Default -1. if < 0, loop unlimited. else, loop loopCount times.
+        /// Default -1. if &lt; 0, loop unlimited. else, loop loopCount times.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public static readonly int LoopCount = NDalic.IMAGE_VISUAL_LOOP_COUNT;
index 4c4191e9d0d9f53aadbbc8989dc459d1dc1f0030..1008473f155d5d13d191a40274ba60fa949b8b31 100755 (executable)
@@ -2425,7 +2425,7 @@ namespace Tizen.NUI
 
         /// <summary>
         /// Gets and Sets the number of times the AnimatedImageVisual will be looped.
-        /// Default -1. if < 0, loop unlimited. else, loop loopCount times.
+        /// Default -1. if &lt; 0, loop unlimited. else, loop loopCount times.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
         public float LoopCount
index 6986de1926fa75d96ac06479b44f440d8b2b5d04..fd04d63ac2f31db5fc9236728cc8fe5f7c3935a9 100644 (file)
@@ -405,7 +405,7 @@ namespace Tizen.Pims.Contacts
         /// <privilege>http://tizen.org/privilege/contact.write</privilege>
         /// <privilege>http://tizen.org/privilege/callhistory.write</privilege>
         /// <feature>http://tizen.org/feature/contact</feature>
-        /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation<./exception>
+        /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
         /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
         /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>
         /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
index 42d7da597ee78967d4267e0d5033e10e31bb6050..ad737c5743ffb5809e58f572bba4d441b7a0fa24 100644 (file)
@@ -337,7 +337,7 @@ namespace Tizen.Pims.Contacts
         /// Adds a child record to the parent record.
         /// </summary>
         /// <param name="propertyId">The property ID.</param>
-        /// <param name="childRecord">The child record to add to the parent record<./param>
+        /// <param name="childRecord">The child record to add to the parent record.</param>
         /// <feature>http://tizen.org/feature/contact</feature>
         /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
         /// <exception cref="ArgumentException">Thrown when one of the arguments provided to a method is not valid.</exception>