Skip to content

Commit 8837e04

Browse files
committed
doc: create structs.h documentation
1 parent e13b51e commit 8837e04

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

libs/structs.h

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,18 @@
44

55
#include <stdlib.h>
66

7+
/**
8+
* @struct Node
9+
*
10+
* @brief Node allocated in the HEAP memory.
11+
*/
712
typedef struct Node {
8-
void* __data;
9-
size_t __sizeOfData;
10-
struct Node* __next;
13+
void* __data; /** Pointer to the data stored. */
14+
size_t __sizeOfData; /** Size in bytes of the stored data. */
15+
struct Node* __next; /** Pointer to the next linked node. */
1116
} Node;
1217

18+
// TODO: create doxygen documentation
1319
typedef struct {
1420
size_t x;
1521
size_t y;

0 commit comments

Comments
 (0)