From 3a9327d1be48893a13578088be969e4cf5896efa Mon Sep 17 00:00:00 2001
From: Romuald Conty <romuald@libnfc.org>
Date: Fri, 6 May 2011 23:25:41 +0000
Subject: [PATCH] document nfc_abort_command()

---
 libnfc/nfc.c | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/libnfc/nfc.c b/libnfc/nfc.c
index 0ddcb4c..45281f6 100644
--- a/libnfc/nfc.c
+++ b/libnfc/nfc.c
@@ -645,7 +645,17 @@ nfc_target_init (nfc_device_t * pnd, nfc_target_t * pnt, byte_t * pbtRx, size_t
   HAL (target_init, pnd, pnt, pbtRx, pszRx);
 }
 
-/* TODO Document this function */
+/**
+ * @brief Abort current running command
+ * @return Returns \c true if action was successfully performed; otherwise returns \c false.
+ *
+ * @param pnd \a nfc_device_t struct pointer that represent currently used device
+ *
+ * Some commands (ie. nfc_target_init()) are blocking functions and will return only in particular conditions (ie. external initiator request).
+ * This function attempt to abort the current running command.
+ *
+ * @note The blocking function (ie. nfc_target_init()) will failed with DEABORT error.
+ */
 bool
 nfc_abort_command (nfc_device_t * pnd)
 {