ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #9326 from hasnainvirk/nfc_doxy 

Doxygen correction
pull/9645/head
Cruz Monrreal 2019-02-12 20:27:17 -06:00 committed by GitHub
parent 3e6cd4e89d 2670eaf82d
commit e84319fe70
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 29 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
features/nfc/nfc/NFCController.h
View File

@ -1,4 +1,6 @@
/* mbed Microcontroller Library /** @file NFCController.h
*
* mbed Microcontroller Library
* Copyright (c) 2018 ARM Limited * Copyright (c) 2018 ARM Limited
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
@ -31,15 +33,14 @@
namespace mbed { namespace mbed {
namespace nfc { namespace nfc {
/** @addtogroup nfc
* @{
*/
class NFCRemoteInitiator; class NFCRemoteInitiator;
class NFCRemoteTarget; class NFCRemoteTarget;
class NFCControllerDriver; class NFCControllerDriver;
/**
* @addtogroup nfc
* @{
*/
/** /**
* This class represents a NFC Controller. * This class represents a NFC Controller.
* *
@ -178,11 +179,7 @@ private:
bool _discovery_running; bool _discovery_running;
Span<uint8_t> _ndef_buffer; Span<uint8_t> _ndef_buffer;
}; };
/** @}*/
/**
* @}
*/
} // namespace nfc } // namespace nfc
} // namespace mbed } // namespace mbed

14
features/nfc/nfc/NFCEEPROM.h
View File

@ -1,4 +1,6 @@
/* mbed Microcontroller Library /** @file NFCEEPROM.h
*
* mbed Microcontroller Library
* Copyright (c) 2018 ARM Limited * Copyright (c) 2018 ARM Limited
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
@ -27,8 +29,7 @@
namespace mbed { namespace mbed {
namespace nfc { namespace nfc {
/** /** @addtogroup nfc
* @addtogroup nfc
* @{ * @{
*/ */
@ -153,12 +154,7 @@ private:
uint32_t _eeprom_address; uint32_t _eeprom_address;
nfc_err_t _operation_result; nfc_err_t _operation_result;
}; };
/** @}*/
/**
* @}
*/
} // namespace nfc } // namespace nfc
} // namespace mbed } // namespace mbed

13
features/nfc/nfc/ndef/MessageBuilder.h
View File

@ -1,4 +1,6 @@
/* mbed Microcontroller Library /** @file MessageBuilder.h
*
* mbed Microcontroller Library
* Copyright (c) 2018 ARM Limited * Copyright (c) 2018 ARM Limited
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
@ -27,8 +29,7 @@ namespace mbed {
namespace nfc { namespace nfc {
namespace ndef { namespace ndef {
/** /** @addtogroup nfc
* @addtogroup nfc
* @{ * @{
*/ */
@ -189,11 +190,7 @@ private:
bool _message_ended; bool _message_ended;
bool _in_chunk; bool _in_chunk;
}; };
/** @}*/
/**
* @}
*/
} // namespace ndef } // namespace ndef
} // namespace nfc } // namespace nfc
} // namespace mbed } // namespace mbed

15
features/nfc/nfc/ndef/MessageParser.h
View File

@ -1,4 +1,6 @@
/* mbed Microcontroller Library /** @file MessageParser.h
*
* mbed Microcontroller Library
* Copyright (c) 2018 ARM Limited * Copyright (c) 2018 ARM Limited
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
@ -18,19 +20,16 @@
#define NFC_NDEF_MESSAGEPARSER_H_ #define NFC_NDEF_MESSAGEPARSER_H_
#include <stdlib.h> #include <stdlib.h>
#include "platform/Span.h" #include "platform/Span.h"
namespace mbed { namespace mbed {
namespace nfc { namespace nfc {
namespace ndef { namespace ndef {
/** /** @addtogroup nfc
* @addtogroup nfc
* @{ * @{
*/ */
// Forward declaration // Forward declaration
class Record; class Record;
@ -165,11 +164,7 @@ private:
Delegate *_delegate; Delegate *_delegate;
}; };
/** @}*/
/**
* @}
*/
} // namespace ndef } // namespace ndef
} // namespace nfc } // namespace nfc
} // namespace mbed } // namespace mbed

14
features/nfc/nfc/ndef/common/SimpleMessageParser.h
View File

@ -1,4 +1,6 @@
/* mbed Microcontroller Library /** @file SimpleMessageParser.h
*
* mbed Microcontroller Library
* Copyright (c) 2018 ARM Limited * Copyright (c) 2018 ARM Limited
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
@ -30,8 +32,7 @@ namespace nfc {
namespace ndef { namespace ndef {
namespace common { namespace common {
/** /** @addtogroup nfc
* @addtogroup nfc
* @{ * @{
*/ */
@ -161,14 +162,11 @@ private:
MimeParser _mime_parser; MimeParser _mime_parser;
Delegate *_delegate; Delegate *_delegate;
}; };
/** @}*/
/**
* @}
*/
} // namespace common } // namespace common
} // namespace ndef } // namespace ndef
} // namespace nfc } // namespace nfc
} // namespace mbed } // namespace mbed
#endif /* NFC_COMMON_SIMPLEMESSAGEPARSER_H_ */ #endif /* NFC_COMMON_SIMPLEMESSAGEPARSER_H_ */