Use Doxygen for generating documentation

.gitignore

@@ -1,3 +1,6 @@
+# Doxygen folder
+docs/html
+
 # Binaries
 bin
 

include/BigInt.hpp

@@ -1,21 +1,25 @@
-/*
-    ===========================================================================
-    BigInt
-    ===========================================================================
-    Definition for the BigInt class.
-*/
+/**
+ * @file BigInt.hpp
+ *
+ * @brief Contains class declaration for BigInt
+ */
 
 #ifndef BIG_INT_HPP
 #define BIG_INT_HPP
 
 #include <iostream>
 
+/**
+ * @brief Class that contains an arbitrarily sized integer. 
+ */
 class BigInt {
+
     std::string value;
     char sign;
 
     public:
-        // Constructors:
+
+        // Constructors 
         BigInt();
         BigInt(const BigInt&);
         BigInt(const long long&);

include/constructors/constructors.hpp

@@ -1,7 +1,7 @@
-/*
-    ===========================================================================
-    Constructors
-    ===========================================================================
+/**
+ * @file constructors/constructors.hpp
+ *
+ * @brief contains constructors of BigInt
 */
 
 #ifndef BIG_INT_CONSTRUCTORS_HPP
@@ -11,32 +11,35 @@
 #include "functions/utility.hpp"
 
 
-/*
-    Default constructor
-    -------------------
-*/
-
+/**
+ *  @brief  Default constructor for BigInt
+ *  
+ *  @return BigInt with value initialized to zero.
+ */ 
 BigInt::BigInt() {
     value = "0";
     sign = '+';
 }
 
 
-/*
-    Copy constructor
-    ----------------
-*/
-
+/**
+ *  @brief Copy constructor for BigInt
+ *
+ *  @param num a BigInt that is to be copied
+ *  @return BigInt with equal value as `num` 
+ */
 BigInt::BigInt(const BigInt& num) {
     value = num.value;
     sign = num.sign;
 }
 
 
-/*
-    Integer to BigInt
-    -----------------
-*/
+/**
+ *  @brief Constructor that converts `long long` to BigInt
+ *
+ *  @param num a `long long` value
+ *  @return BigInt with equal value as `num`
+ */
 
 BigInt::BigInt(const long long& num) {
     value = std::to_string(std::abs(num));
@@ -47,11 +50,12 @@ BigInt::BigInt(const long long& num) {
 }
 
 
-/*
-    String to BigInt
-    ----------------
-*/
-
+/**
+ *  @brief Constructor that converts `std::string` to BigInt
+ *
+ *  @param num std::string that represents an integer
+ *  @return BigInt with value represented in `num`
+ */
 BigInt::BigInt(const std::string& num) {
     if (num[0] == '+' or num[0] == '-') {     // check for sign
         std::string magnitude = num.substr(1);

include/functions/conversion.hpp

@@ -1,59 +1,59 @@
-/*
-    ===========================================================================
-    Conversion functions for BigInt
-    ===========================================================================
-*/
+/**
+ * @file functions/conversion.hpp
+ * 
+ * @brief Contains conversion related functions of BigInt
+ */
 
 #ifndef BIG_INT_CONVERSION_FUNCTIONS_HPP
 #define BIG_INT_CONVERSION_FUNCTIONS_HPP
 
 
-/*
-    to_string
-    ---------
-    Converts a BigInt to a string.
-*/
 
+/**
+ * @brief Converts BigInt into an `std::string` representation
+ * 
+ * Returns the string representation of the integer with a prefix of
+ * '-' if negative, and no prefix otherwise.
+ *
+ * @return `std::string` representing BigInt value
+ */
 std::string BigInt::to_string() const {
     // prefix with sign if negative
     return this->sign == '-' ? "-" + this->value : this->value;
 }
 
 
-/*
-    to_int
-    ------
-    Converts a BigInt to an int.
-    NOTE: If the BigInt is out of range of an int, stoi() will throw an
-    out_of_range exception.
-*/
-
+/**
+ * @brief Converts BigInt into `int`
+ *
+ * @return `int` containing BigInt value.
+ * \warning If the BigInt range is outside the accepted range of an `int`,
+ * `out_of_range` exception will be thrown.
+ */
 int BigInt::to_int() const {
     return std::stoi(this->to_string());
 }
 
 
-/*
-    to_long
-    -------
-    Converts a BigInt to a long int.
-    NOTE: If the BigInt is out of range of a long int, stol() will throw an
-    out_of_range exception.
-*/
-
+/**
+ * @brief Converts BigInt into `long`
+ *
+ * @return `long` containing BigInt value.
+ * \warning If the BigInt range is outside the accepted range of an `long`,
+ * `out_of_range` exception will be thrown.
+ */
 long BigInt::to_long() const {
     return std::stol(this->to_string());
 }
 
 
-/*
-    to_long_long
-    ------------
-    Converts a BigInt to a long long int.
-    NOTE: If the BigInt is out of range of a long long int, stoll() will throw
-    an out_of_range exception.
-*/
-
+/**
+ * @brief Converts BigInt into `long long`
+ *
+ * @return `long long` containing BigInt value.
+ * \warning If the BigInt range is outside the accepted range of an `long long`,
+ * `out_of_range` exception will be thrown.
+ */
 long long BigInt::to_long_long() const {
     return std::stoll(this->to_string());
 }