diff options
author | Oleg Zhurakivskyy <oleg.zhurakivskyy@intel.com> | 2014-08-19 13:36:48 +0300 |
---|---|---|
committer | Samuel Ortiz <sameo@linux.intel.com> | 2014-09-08 00:38:53 +0200 |
commit | d848a27255820920b7a1da45d276b91f82f60200 (patch) | |
tree | 32167d2b9a41242280df58b5a0672c325f1eb51b | |
parent | 3e7187f0ac5d55c9d098c47a8f57f28ba83ba510 (diff) | |
download | neardal-d848a27255820920b7a1da45d276b91f82f60200.tar.gz neardal-d848a27255820920b7a1da45d276b91f82f60200.tar.bz2 neardal-d848a27255820920b7a1da45d276b91f82f60200.zip |
neardal_record doc cleanup.
-rw-r--r-- | lib/neardal.h | 44 |
1 files changed, 19 insertions, 25 deletions
diff --git a/lib/neardal.h b/lib/neardal.h index 537d2c3..473d027 100644 --- a/lib/neardal.h +++ b/lib/neardal.h @@ -103,32 +103,26 @@ typedef struct { char **records; } neardal_dev; -/*! - * @brief NEARDAL Record client properties. - * release with (@link neardal_free_record @endlink) -*/ +/** + * NFC record. Release with neardal_free_record(). + */ typedef struct { -/*! @brief DBus interface name (as identifier) */ - char *name; -/*! @brief The character encoding */ - char *encoding; -/*! @brief The ISO/IANA language code (For example "en" or "jp") */ - char *language; -/*! @brief 'Action' Save, Edit, Download... */ - char *action; -/*! @brief The NDEF record type name ("SmartPoster", "Text", "URI", - * "HandoverRequest", "HandoverSelect", "HandoverCarrier" */ - char *type; -/*! @brief human readable representation of a text or title record. */ - char *representation; -/*! @brief the complete URI, including the scheme and the resource */ - char *uri; -/*! @brief URI object size */ - unsigned int uriObjSize; -/*! @brief The URI object MIME type */ - char *mime; -/*! @brief The Handover Carrier (e.g. bluetooth) */ - char *carrier; + char *action; /**< Action. Save, Edit, Download. */ + char *carrier; /**< Handover carrier. Bluetooth. */ + char *encoding; /**< Encoding. */ + char *language; /**< Language. ISO/IANA: en, jp, etc. */ + char *mime; /**< MIME type. */ + char *name; /**< Identifier. DBus path. */ + char *representation; /**< Human readable representation. */ + char *type; /**< NDEF record type. + Text, + URI, + SmartPoster, + HandoverCarrier, + HandoverRequest, + HandoverSelect. */ + char *uri; /**< URI including scheme and resource. */ + unsigned int uriObjSize;/**< URI object size. */ } neardal_record; /* @}*/ |