Skip to content

Commit e84319f

Browse files
author
Cruz Monrreal
authored
Merge pull request #9326 from hasnainvirk/nfc_doxy
Doxygen correction
2 parents 3e6cd4e + 2670eaf commit e84319f

File tree

5 files changed

+29
-46
lines changed

5 files changed

+29
-46
lines changed

features/nfc/nfc/NFCController.h

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
/* mbed Microcontroller Library
1+
/** @file NFCController.h
2+
*
3+
* mbed Microcontroller Library
24
* Copyright (c) 2018 ARM Limited
35
*
46
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -31,15 +33,14 @@
3133
namespace mbed {
3234
namespace nfc {
3335

36+
/** @addtogroup nfc
37+
* @{
38+
*/
39+
3440
class NFCRemoteInitiator;
3541
class NFCRemoteTarget;
3642
class NFCControllerDriver;
3743

38-
/**
39-
* @addtogroup nfc
40-
* @{
41-
*/
42-
4344
/**
4445
* This class represents a NFC Controller.
4546
*
@@ -178,11 +179,7 @@ class NFCController : private NFCControllerDriver::Delegate {
178179
bool _discovery_running;
179180
Span<uint8_t> _ndef_buffer;
180181
};
181-
182-
/**
183-
* @}
184-
*/
185-
182+
/** @}*/
186183
} // namespace nfc
187184
} // namespace mbed
188185

features/nfc/nfc/NFCEEPROM.h

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
/* mbed Microcontroller Library
1+
/** @file NFCEEPROM.h
2+
*
3+
* mbed Microcontroller Library
24
* Copyright (c) 2018 ARM Limited
35
*
46
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,8 +29,7 @@
2729
namespace mbed {
2830
namespace nfc {
2931

30-
/**
31-
* @addtogroup nfc
32+
/** @addtogroup nfc
3233
* @{
3334
*/
3435

@@ -153,12 +154,7 @@ class NFCEEPROM : public NFCTarget, public NFCEEPROMDriver::Delegate {
153154
uint32_t _eeprom_address;
154155
nfc_err_t _operation_result;
155156
};
156-
157-
/**
158-
* @}
159-
*/
160-
161-
157+
/** @}*/
162158
} // namespace nfc
163159
} // namespace mbed
164160

features/nfc/nfc/ndef/MessageBuilder.h

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
/* mbed Microcontroller Library
1+
/** @file MessageBuilder.h
2+
*
3+
* mbed Microcontroller Library
24
* Copyright (c) 2018 ARM Limited
35
*
46
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,8 +29,7 @@ namespace mbed {
2729
namespace nfc {
2830
namespace ndef {
2931

30-
/**
31-
* @addtogroup nfc
32+
/** @addtogroup nfc
3233
* @{
3334
*/
3435

@@ -189,11 +190,7 @@ class MessageBuilder {
189190
bool _message_ended;
190191
bool _in_chunk;
191192
};
192-
193-
/**
194-
* @}
195-
*/
196-
193+
/** @}*/
197194
} // namespace ndef
198195
} // namespace nfc
199196
} // namespace mbed

features/nfc/nfc/ndef/MessageParser.h

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
/* mbed Microcontroller Library
1+
/** @file MessageParser.h
2+
*
3+
* mbed Microcontroller Library
24
* Copyright (c) 2018 ARM Limited
35
*
46
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,19 +20,16 @@
1820
#define NFC_NDEF_MESSAGEPARSER_H_
1921

2022
#include <stdlib.h>
21-
2223
#include "platform/Span.h"
2324

2425
namespace mbed {
2526
namespace nfc {
2627
namespace ndef {
2728

28-
/**
29-
* @addtogroup nfc
29+
/** @addtogroup nfc
3030
* @{
3131
*/
3232

33-
3433
// Forward declaration
3534
class Record;
3635

@@ -165,11 +164,7 @@ class MessageParser {
165164

166165
Delegate *_delegate;
167166
};
168-
169-
/**
170-
* @}
171-
*/
172-
167+
/** @}*/
173168
} // namespace ndef
174169
} // namespace nfc
175170
} // namespace mbed

features/nfc/nfc/ndef/common/SimpleMessageParser.h

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
/* mbed Microcontroller Library
1+
/** @file SimpleMessageParser.h
2+
*
3+
* mbed Microcontroller Library
24
* Copyright (c) 2018 ARM Limited
35
*
46
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -30,8 +32,7 @@ namespace nfc {
3032
namespace ndef {
3133
namespace common {
3234

33-
/**
34-
* @addtogroup nfc
35+
/** @addtogroup nfc
3536
* @{
3637
*/
3738

@@ -161,14 +162,11 @@ class SimpleMessageParser :
161162
MimeParser _mime_parser;
162163
Delegate *_delegate;
163164
};
164-
165-
/**
166-
* @}
167-
*/
168-
165+
/** @}*/
169166
} // namespace common
170167
} // namespace ndef
171168
} // namespace nfc
172169
} // namespace mbed
173170

174171
#endif /* NFC_COMMON_SIMPLEMESSAGEPARSER_H_ */
172+

0 commit comments

Comments
 (0)