From 34c2c736a525fc893675ecc8a4952602d8a6f51d Mon Sep 17 00:00:00 2001 From: Florian Burgener <florian.brgnr@gmail.com> Date: Tue, 7 Jun 2022 21:13:36 +0200 Subject: [PATCH] Add header in source files --- src/Array.c | 7 +++++++ src/Array.h | 7 +++++++ src/BPTree.c | 7 +++++++ src/BPTree.h | 7 +++++++ src/Directory.c | 10 ++++++++-- src/Directory.h | 7 +++++++ src/DirectoryRecord.c | 7 +++++++ src/DirectoryRecord.h | 7 +++++++ src/main.c | 7 +++++++ src/tests/BPTreeTests.c | 2 +- 10 files changed, 65 insertions(+), 3 deletions(-) diff --git a/src/Array.c b/src/Array.c index 147a529..34ea239 100644 --- a/src/Array.c +++ b/src/Array.c @@ -1,3 +1,10 @@ +/** + * @file Array.c + * @author Florian Burgener (florian.burgener@etu.hesge.ch) + * @brief + * @version 1.0 + * @date 2022-06-XX + */ #include "Array.h" #include <stdbool.h> diff --git a/src/Array.h b/src/Array.h index f59ccf0..1bf35ae 100644 --- a/src/Array.h +++ b/src/Array.h @@ -1,3 +1,10 @@ +/** + * @file Array.h + * @author Florian Burgener (florian.burgener@etu.hesge.ch) + * @brief + * @version 1.0 + * @date 2022-06-XX + */ #ifndef ARRAY_H #define ARRAY_H diff --git a/src/BPTree.c b/src/BPTree.c index a6432e9..9c4f770 100644 --- a/src/BPTree.c +++ b/src/BPTree.c @@ -1,3 +1,10 @@ +/** + * @file BPTree.c + * @author Florian Burgener (florian.burgener@etu.hesge.ch) + * @brief + * @version 1.0 + * @date 2022-06-XX + */ #include "BPTree.h" #include <stdbool.h> diff --git a/src/BPTree.h b/src/BPTree.h index 762df82..3f58424 100644 --- a/src/BPTree.h +++ b/src/BPTree.h @@ -1,3 +1,10 @@ +/** + * @file BPTree.h + * @author Florian Burgener (florian.burgener@etu.hesge.ch) + * @brief + * @version 1.0 + * @date 2022-06-XX + */ #ifndef BPTREE_H #define BPTREE_H diff --git a/src/Directory.c b/src/Directory.c index a4b7013..bbfce59 100644 --- a/src/Directory.c +++ b/src/Directory.c @@ -1,5 +1,10 @@ -// CAUTION : Je devrais refactor l'implémentation avec le FILE. - +/** + * @file Directory.c + * @author Florian Burgener (florian.burgener@etu.hesge.ch) + * @brief + * @version 1.0 + * @date 2022-06-XX + */ #include "Directory.h" #include <openssl/sha.h> @@ -11,6 +16,7 @@ #include "Array.h" #include "BPTree.h" #include "DirectoryRecord.h" +// CAUTION : Je devrais refactor l'implémentation avec le FILE. static uint64_t hash_string(char *str) { SHA256_CTX sha256; diff --git a/src/Directory.h b/src/Directory.h index e72efc6..3ed1878 100644 --- a/src/Directory.h +++ b/src/Directory.h @@ -1,3 +1,10 @@ +/** + * @file Directory.h + * @author Florian Burgener (florian.burgener@etu.hesge.ch) + * @brief + * @version 1.0 + * @date 2022-06-XX + */ #ifndef DIRECTORY_H #define DIRECTORY_H diff --git a/src/DirectoryRecord.c b/src/DirectoryRecord.c index 594b9b9..bb0fb13 100644 --- a/src/DirectoryRecord.c +++ b/src/DirectoryRecord.c @@ -1,3 +1,10 @@ +/** + * @file DirectoryRecord.c + * @author Florian Burgener (florian.burgener@etu.hesge.ch) + * @brief + * @version 1.0 + * @date 2022-06-XX + */ #include "DirectoryRecord.h" #include <stdbool.h> diff --git a/src/DirectoryRecord.h b/src/DirectoryRecord.h index 4909e36..3466d9a 100644 --- a/src/DirectoryRecord.h +++ b/src/DirectoryRecord.h @@ -1,3 +1,10 @@ +/** + * @file DirectoryRecord.h + * @author Florian Burgener (florian.burgener@etu.hesge.ch) + * @brief + * @version 1.0 + * @date 2022-06-XX + */ #ifndef DIRECTORY_RECORD_H #define DIRECTORY_RECORD_H diff --git a/src/main.c b/src/main.c index 8a63479..c91a757 100644 --- a/src/main.c +++ b/src/main.c @@ -1,3 +1,10 @@ +/** + * @file main.c + * @author Florian Burgener (florian.burgener@etu.hesge.ch) + * @brief + * @version 1.0 + * @date 2022-06-XX + */ #include <assert.h> #include <stdlib.h> diff --git a/src/tests/BPTreeTests.c b/src/tests/BPTreeTests.c index a6996d4..4e05be0 100644 --- a/src/tests/BPTreeTests.c +++ b/src/tests/BPTreeTests.c @@ -3,7 +3,7 @@ * @author Florian Burgener (florian.burgener@etu.hesge.ch) * @brief Unit tests of the BPTree data structure. * @version 1.0 - * @date 2022-06-07 + * @date 2022-06-XX */ #include <stdbool.h> #include <stdint.h> -- GitLab