Skip to content

Commit 69f7e6c

Browse files
committed
Make function documentation Doxygen style
1 parent c911cda commit 69f7e6c

File tree

2 files changed

+11
-12
lines changed

2 files changed

+11
-12
lines changed

src/ecc608.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,4 +92,4 @@ uint8_t ECC608Class::readProvisionItem(enum ecc_data_types type,
9292

9393
*length = 0;
9494
return this->ERR_NOTFOUND;
95-
}
95+
}

src/ecc608.h

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
#ifndef ECC608_H
32
#define ECC608_H
43

@@ -58,22 +57,21 @@ class ECC608Class {
5857
ECC608Class(){};
5958

6059
/*
61-
* Extract item with given type from ECC slot.
60+
* @brief Extract item with given type from ECC slot.
6261
*
6362
* This code traverses the list until matching type is found,
6463
* assuming there is only one item of each type in the slot.
6564
* Notice: A \0 terminator is added to the returned item for
6665
* easier string processing. This is not included in returned
6766
* length, but there must be space for it in the buffer.
6867
*
69-
* Parameters:
70-
* type: Type of requested item
71-
* buffer: Buffer to store item in
72-
* length: Pointer to length of buffer (== max length of returned data),
73-
* set to actual item length on return
74-
* Returns:
75-
* Error code: 0 => OK, 1-0xff => cryptoauth error code, >= 0x100: see
76-
* ecc_provision.h
68+
* @param type Type of requested item
69+
* @param buffer Buffer to store item in
70+
* @param length Pointer to length of buffer (== max length of returned
71+
* data), set to actual item length on return
72+
*
73+
* @return Error code: 0 => OK, 1-0xff => cryptoauth error code, >= 0x100:
74+
* see ecc_provision.h
7775
*/
7876
uint8_t readProvisionItem(enum ecc_data_types type,
7977
uint8_t *buffer,
@@ -99,11 +97,12 @@ class ECC608Class {
9997
};
10098

10199
uint8_t getEndpoint(uint8_t *endpoint, uint8_t *length);
100+
102101
uint8_t getThingName(uint8_t *thingName, uint8_t *length);
103102

104103
uint8_t begin();
105104
};
106105

107106
extern ECC608Class ECC608;
108107

109-
#endif
108+
#endif

0 commit comments

Comments
 (0)