diff options
author | Yunjin Lee <yunjin-.lee@samsung.com> | 2016-10-13 17:09:22 +0900 |
---|---|---|
committer | Yunjin Lee <yunjin-.lee@samsung.com> | 2016-10-14 16:45:17 +0900 |
commit | e2b75b0a5c05b6b055d10e7198b424df04008c9a (patch) | |
tree | 0243901ec3ed0b1255e33dd4051e4c5ac5ba64b1 | |
parent | 6b77b2a17a7c78e183abee25c94579328262d76c (diff) | |
download | security-e2b75b0a5c05b6b055d10e7198b424df04008c9a.tar.gz security-e2b75b0a5c05b6b055d10e7198b424df04008c9a.tar.bz2 security-e2b75b0a5c05b6b055d10e7198b424df04008c9a.zip |
Modify API doc
-Add remarks to GetDisplayName() and GetDescription() for undefined privilege input parameter
-Remove error case return remarks from GetPrivacyPrivilegeStatus()
Change-Id: Ic94f8c367b504892acaa11954506351d5ce8e2d5
Signed-off-by: Yunjin Lee <yunjin-.lee@samsung.com>
-rwxr-xr-x | Tizen.Security/Tizen.Security/Privilege.cs | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/Tizen.Security/Tizen.Security/Privilege.cs b/Tizen.Security/Tizen.Security/Privilege.cs index 91a72d2..420cb71 100755 --- a/Tizen.Security/Tizen.Security/Privilege.cs +++ b/Tizen.Security/Tizen.Security/Privilege.cs @@ -47,6 +47,7 @@ namespace Tizen.Security /// <summary> /// Gets the display name of the given privilege. /// </summary> + /// <remarks>If there's no matching privilege then it returns last token of given privilege.</remarks> /// <param name="apiVersion">The api version</param> /// <param name="privilege">The privilege</param> /// <returns>The display name of given privilege at given api version</returns> @@ -63,6 +64,7 @@ namespace Tizen.Security /// <summary> /// Gets the display name of the given privilege. /// </summary> + /// <remarks>If there's no matching privilege then it returns last token of given privilege.</remarks> /// <param name="apiVersion">The api version</param> /// <param name="privilege">The privilege</param> /// <param name="packageType">The type of application package</param> @@ -80,6 +82,7 @@ namespace Tizen.Security /// <summary> /// Gets the description of the given privilege. /// </summary> + /// <remarks>If there's no matching privilege then it returns description string for undefined privilege.</remarks> /// <param name="apiVersion">The api version</param> /// <param name="privilege">The privilege</param> /// <returns>The description of given privilege at given api version</returns> @@ -96,6 +99,7 @@ namespace Tizen.Security /// <summary> /// Gets the description of the given privilege. /// </summary> + /// <remarks>If there's no matching privilege then it returns description string for undefined privilege.</remarks> /// <param name="apiVersion">The api version</param> /// <param name="privilege">The privilege</param> /// <param name="packageType">The type of application package</param> @@ -131,7 +135,6 @@ namespace Tizen.Security /// </summary> /// <param name="privilege">The privilege</param> /// <remarks>The privilege must be privacy related.</remarks> - /// <remarks>In case of errors, status is set to true</remarks> /// <returns>status true if the privilege is on and false if the privilege is off.</returns> /// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception> /// <exception cref="System.InvalidOperationException">Thrown when internal error occurs.</exception> |