From 42f2db6295cdabd870a99e43023afd6ead8e4029 Mon Sep 17 00:00:00 2001
From: SuperNovaa41 <supernovaa41@gmx.com>
Date: Wed, 24 Jan 2024 18:40:48 -0500
Subject: [PATCH] adds documentation

---
 api/isbn-interaction.cpp |  8 +++-----
 api/isbn-interaction.h   | 20 ++++++++++++++++++++
 2 files changed, 23 insertions(+), 5 deletions(-)

diff --git a/api/isbn-interaction.cpp b/api/isbn-interaction.cpp
index 1a3b9d5..c2b714d 100644
--- a/api/isbn-interaction.cpp
+++ b/api/isbn-interaction.cpp
@@ -12,8 +12,7 @@
 #define BOOK_FILENAME "books.csv"
 
 std::string book_vec_to_json(std::vector<std::string> headers, std::vector<std::string> book)
-{
-	int i;
+{ int i;
 	std::string out = "{";
 
 	for (i = 0; i < book.size(); i++) {
@@ -56,14 +55,13 @@ std::string get_all_books()
 	return total_lines + "}";
 }
 
-std::string remove_book(int id)
+std::string remove_book(std::string id)
 {
 	enum ISBN_EXIT_CODE exec_code;
 	std::string program_name = "./isbn";
 	std::string remove = "remove";
-	std::string str_id = std::to_string(id);
 
-	char* args[] = {(char*) program_name.c_str(), (char*) remove.c_str(), (char*) str_id.c_str(), NULL};
+	char* args[] = {(char*) program_name.c_str(), (char*) remove.c_str(), (char*) id.c_str(), NULL};
 
 	switch (exec_code) {
 		case FORK_FAILED:
diff --git a/api/isbn-interaction.h b/api/isbn-interaction.h
index 3c026ac..8d6d52d 100644
--- a/api/isbn-interaction.h
+++ b/api/isbn-interaction.h
@@ -25,8 +25,28 @@ std::string book_vec_to_json(std::vector<std::string> headers, std::vector<std::
  */
 std::string get_all_books();
 
+/**
+ * std::string add_new_book
+ * std::string isbn - The isbn of the book
+ *
+ * Executes the ISBN program using the given ISBN to add a book
+ */
 std::string add_new_book(std::string isbn);
 
+/**
+ * std::string remove_book
+ * std::string id - The book id to remove
+ *
+ * Executes the ISBN program using the given ID to remove a book
+ */
+std::string remove_book(std::string id);
+
+/**
+ * enum ISBN_EXIT_CODE run_isbn_program
+ * char* args[] - The char* list of arguments to pass to execvp
+ *
+ * Executes the ISBN program with the given arguments, returns the proper exit code
+ */
 enum ISBN_EXIT_CODE run_isbn_program(char* args[]);