Document the mifare_tag_type enum.

This commit is contained in:
Romain Tartiere 2010-07-01 12:32:03 +00:00
parent 06e61a89d5
commit 0e1aded982
2 changed files with 9 additions and 0 deletions

View file

@ -37,6 +37,8 @@ infrastructure ready for hacking the new card support:
- Edit libfreefare/freefare.h:
- Add your tag to the `mifare_tag_type' enum;
- Add a <tag>_connect() and a <tag>_disconnect() function prototype;
- Edit libfreefare/freefare.3:
- Add your tag to the `mifare_tag_type' enum documentation;
- Edit libfreefare/freefare_internal.h:
- Add a new <tag>_tag struct. It's very first member shall be `struct
mifare_tag __tag';

View file

@ -50,6 +50,13 @@ Mifare card manipulation library (libfreefare, \-lfreefare)
.In freefare.h
.Ft "MifareTag *"
.Fn freefare_get_tags "nfc_device_t *device"
.Bd -literal
enum mifare_tag_type {
ULTRALIGHT,
CLASSIC_1K,
CLASSIC_4K
};
.Ed
.Ft enum mifare_tag_type
.Fn freefare_get_tag_type "MifareTag tag"
.Ft "const char *"