From e775c287567de2269847c09c12de40f6c5bd7d14 Mon Sep 17 00:00:00 2001 From: Jihoon Jung Date: Thu, 26 Sep 2024 15:37:01 +0900 Subject: [PATCH] Enhance API descriptions Signed-off-by: Jihoon Jung --- .../Tizen.Network.Nfc/NfcManager.cs | 36 ++++++++++++------- .../Tizen.Network.Nfc/NfcP2p.cs | 12 ++++--- .../Tizen.Network.Nfc/NfcP2pAdapter.cs | 6 ++-- .../Tizen.Network.Nfc/NfcTag.cs | 4 ++- 4 files changed, 39 insertions(+), 19 deletions(-) mode change 100755 => 100644 src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcManager.cs mode change 100755 => 100644 src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2p.cs mode change 100755 => 100644 src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2pAdapter.cs diff --git a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcManager.cs b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcManager.cs old mode 100755 new mode 100644 index 2331ac6b395..f6b76e924c9 --- a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcManager.cs +++ b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcManager.cs @@ -22,14 +22,16 @@ namespace Tizen.Network.Nfc { /// - /// A class for the NFC management. It allows applications to use the NFC service. + /// The NfcManager class provides methods for managing the NFC service in Tizen applications. + /// It allows applications to initialize and terminate the NFC service, register and unregister NFC tags, and handle NFC events. /// /// 3 /// http://tizen.org/privilege/nfc static public class NfcManager { /// - /// Checks whether the NFC is supported. + /// The IsSupported property checks whether the NFC feature is supported on the device. + /// It returns a boolean value indicating whether the NFC service is available. /// /// 3 static public bool IsSupported @@ -57,7 +59,8 @@ static public bool IsSupported } /// - /// The NFC Activation state. + /// The IsActivated property checks whether the NFC service is currently activated on the device. + /// It returns a boolean value indicating whether the NFC service is active. /// /// 3 static public bool IsActivated @@ -85,7 +88,8 @@ static public bool IsActivated } /// - /// The Tag Filter type. + /// The TagFilterType property specifies the type of tag filtering to be used by the NFC service. + /// It can be set to either NfcTagFilterType.All or NfcTagFilterType.NdefOnly, depending on the desired behavior. /// /// 3 static public NfcTagFilterType TagFilterType @@ -137,7 +141,8 @@ static public NfcTagFilterType TagFilterType } /// - /// The Secure Element type. + /// The SecureElementType property specifies the type of Secure Element (SE) to be used by the NFC service. + /// It can be set to either NfcSecureElementType.Uicc or NfcSecureElementType.Ese, depending on the desired behavior. /// /// 3 /// http://tizen.org/privilege/nfc.cardemulation @@ -239,7 +244,7 @@ static public bool SystemHandlerEnabled } /// - /// The cached NDEF message. + /// The CachedNdefMessage property returns the cached NDEF message, which is a representation of the data stored on an NFC tag. /// /// 3 static public NfcNdefMessage CachedNdefMessage @@ -267,7 +272,8 @@ static public NfcNdefMessage CachedNdefMessage } /// - /// Gets the Tag adapter object. + /// The GetTagAdapter method returns the Tag adapter object, which is used to manage NFC tags in the NFC service. + /// The Tag adapter provides methods for reading, writing, and formatting NFC tags. /// /// 3 static public NfcTagAdapter GetTagAdapter() @@ -294,7 +300,9 @@ static public NfcTagAdapter GetTagAdapter() } /// - /// Gets the P2P adapter object. + /// The GetP2pAdapter method returns the P2P adapter object, + /// which is used to manage NFC peer-to-peer (P2P) communication in the NFC service. + /// The P2P adapter provides methods for initiating and receiving P2P communication. /// /// 3 static public NfcP2pAdapter GetP2pAdapter() @@ -321,7 +329,9 @@ static public NfcP2pAdapter GetP2pAdapter() } /// - /// Gets the Card Emulation adapter object. + /// The GetCardEmulationAdapter method returns the Card Emulation adapter object, + /// which is used to manage NFC card emulation in the NFC service. + /// The Card Emulation adapter provides methods for registering and deregistering services, and for handling card emulation events. /// /// 3 static public NfcCardEmulationAdapter GetCardEmulationAdapter() @@ -348,7 +358,7 @@ static public NfcCardEmulationAdapter GetCardEmulationAdapter() } /// - /// Activates the NFC asynchronously. + /// The SetActivationAsync method activates or deactivates the NFC service asynchronously. /// /// 3 /// A task indicates whether the Activate method is done or not. @@ -375,7 +385,8 @@ static public Task SetActivationAsync(bool activation) } /// - /// The Activation changed event. + /// The ActivationChanged event is triggered when the NFC activation state changes. + /// The event handler receives an ActivationChangedEventArgs object containing information about the activation state change. /// /// 3 static public event EventHandler ActivationChanged @@ -423,7 +434,8 @@ static public event EventHandler ActivationChanged } /// - /// The NDEF discovered event. + /// The NdefMessageDiscovered event is triggered when an NDEF message is discovered by the NFC service. + /// The event handler receives an NdefMessageDiscoveredEventArgs object containing information about the discovered NDEF message. /// /// 3 static public event EventHandler NdefMessageDiscovered diff --git a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2p.cs b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2p.cs old mode 100755 new mode 100644 index 4842decd8f3..3b234553689 --- a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2p.cs +++ b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2p.cs @@ -22,7 +22,8 @@ namespace Tizen.Network.Nfc { /// - /// The class for managing the P2P target information. + /// The NfcP2p class provides methods for managing the P2P target information. + /// It allows applications to send and receive P2P messages, and to handle P2P connection events. /// /// 3 public class NfcP2p : IDisposable @@ -35,7 +36,9 @@ public class NfcP2p : IDisposable private Interop.Nfc.P2pDataReceivedCallback _p2pDataReceivedCallback; /// - /// The event for receiving data from the NFC peer-to-peer target. + /// The P2pDataReceived event is triggered when data is received from an NFC peer-to-peer target. + /// The event handler receives a P2pDataReceivedEventArgs object containing the received data. + /// This event is typically used in conjunction with the NfcP2pAdapter class to handle incoming P2P messages. /// /// 3 public event EventHandler P2pDataReceived @@ -94,7 +97,7 @@ internal IntPtr GetHandle() } /// - /// Sends data to the NFC peer-to-peer target. + /// The SendNdefMessageAsync method sends an NDEF message to an NFC peer-to-peer target. /// /// 3 /// The NfcNdefMessage object. @@ -144,7 +147,8 @@ private void UnregisterP2pDataReceivedEvent() } /// - /// The class for managing the SNEP (Simple NDEF Exchange Protocol) information. + /// The NfcSnep class provides methods for managing SNEP (Simple NDEF Exchange Protocol) information. + /// It allows applications to send and receive SNEP messages, and to handle SNEP connection events. /// /// 3 public class NfcSnep : IDisposable diff --git a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2pAdapter.cs b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2pAdapter.cs old mode 100755 new mode 100644 index a772fc2ab73..7f57202f70d --- a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2pAdapter.cs +++ b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2pAdapter.cs @@ -21,7 +21,9 @@ namespace Tizen.Network.Nfc { /// - /// The class for the NFC P2P (Peer-to-Peer) mode. It allows applications to handle P2P informations. + /// The NfcP2pAdapter class provides methods for managing NFC peer-to-peer (P2P) communication. + /// It allows applications to initiate and receive P2P communication, + /// and to handle P2P information such as messages and connections. /// /// 3 /// http://tizen.org/privilege/nfc @@ -88,7 +90,7 @@ private void Dispose(bool disposing) } /// - /// Gets the current connected P2P target. + /// The GetConnectedTarget method returns the currently connected P2P target. /// /// 3 /// The NfcP2p object. diff --git a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTag.cs b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTag.cs index a6f193b7d6b..61fa5db6163 100644 --- a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTag.cs +++ b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTag.cs @@ -22,7 +22,9 @@ namespace Tizen.Network.Nfc { /// - /// The class for managing the Tag information. + /// The NfcTag class provides methods for managing tag information. + /// It allows applications to read and write tag information, and to handle tag events such as detection and removal. + /// This class is typically used in conjunction with the NfcManager class to manage tag communication. /// /// 3 public class NfcTag : IDisposable