diff --git a/Doxyfile b/Doxyfile index 31248a3..11a9cd1 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,10 +1,6 @@ -PROJECT_NAME = CTree -PROJECT_NUMBER = $(PROJECT_NUMBER) +PROJECT_NAME = MyProject +PROJECT_NUMBER = 1.0 INPUT = src -RECURSIVE = YES -EXTRACT_ALL = YES -INPUT += README.md -USE_MDFILE_AS_MAINPAGE = README.md OUTPUT_DIRECTORY = docs #EXCLUDE = /path/to/exclude/directory diff --git a/Makefile b/Makefile index 861b543..1a990a8 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,6 @@ # Compiler CC := gcc -GITHASH := $(shell git rev-parse --short HEAD) - # Compiler flags CFLAGS := -Wall -Wextra -Wpedantic -std=c2x @@ -46,7 +44,7 @@ clean: rm -rf $(BUILD_DIR) $(TARGET) docs: - PROJECT_NUMBER=git-$(GITHASH) doxygen Doxyfile + doxygen Doxyfile cppcheck: cppcheck --enable=all --inconclusive --std=c11 --language=c --platform=unix64 --suppress=missingIncludeSystem $(SRCS) diff --git a/README.md b/README.md deleted file mode 100644 index 23d90ff..0000000 --- a/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# CTree Example Project - -Sample project for the CTree library. Testing out writing C with best practices in mind. diff --git a/src/main.c b/src/main.c index 73d2edf..430e662 100644 --- a/src/main.c +++ b/src/main.c @@ -7,15 +7,6 @@ #define ANSI_COLOR_RED "\x1b[31m" #define ANSI_COLOR_RESET "\x1b[0m" -/** - * @brief Assert a condition - * @details If the condition is false, print an error message - * and exit the program - * - * @param condition The condition to assert - * @param message The message to print if the condition is false - * @return 0 if the condition is true - */ int assert(bool condition, const char *message) { if (!condition) { printf(ANSI_COLOR_RED "Assertion failed: %s\n" ANSI_COLOR_RESET, message); diff --git a/src/tree.h b/src/tree.h index c89a820..ef90695 100644 --- a/src/tree.h +++ b/src/tree.h @@ -5,37 +5,20 @@ #include #include -/** - * @brief A node in a binary tree - * @details A node in a binary tree has some data - * and can have a left and right branch - */ +// A regular node with a left and right branch struct Node { - /** @brief The data of the node */ int data; - - /** @see Node */ - struct Node *left; - - /** @see Node */ - struct Node *right; + struct Node *left, *right; }; typedef struct Node Node; -/** @brief Represents a tree with a root node */ +// Represents a tree with a root node struct Tree { - /** @brief The root node of the tree */ Node *root; }; typedef struct Tree Tree; -/** - * @brief Insert some data into the tree - * - * @param tree - * @param data - * @return * Insert - */ +// Insert some data into the tree int tree_insert(Tree *tree, int data); // Remove some data from the tree