Merge pull request #95 from hwangswan/comment

Comment

.github/workflows/c-cpp.yml

@@ -3,12 +3,8 @@ name: C/C++ CI
 on:
   push:
     branches: [ master ]
-  pull_request_target:
-    types:
-      - opened
-      - edited
-      - synchronize
-      - reopened
+  pull_request:
+    branches: [ master ]
 
 jobs:
   linter:
@@ -34,31 +30,12 @@ jobs:
 
     - name: make
       run: make
-      if: ${{ github.event_name == 'push' }}
-
-    - name: make (with test coverage)
-      run: make gcov
-      if: ${{ github.event_name == 'pull_request_target' }}
 
     - name: make - copy test into testing folder
       run: make init_test
 
     - name: make - test
       run: make test
 
-    - name: make - init code coverage
-      run: |
-        sudo apt-get install -y lcov && make lcov
-      if: ${{ github.event_name == 'pull_request_target' }}
-
-    - name: upload code coverage report
-      uses: zgosalvez/github-actions-report-lcov@v1
-      with:
-        coverage-files: coverage.info
-        minimum-coverage: 80
-        artifact-name: code-coverage-report
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-      if: ${{ github.event_name == 'pull_request_target' }}
-
     - name: cleaning afterworks
       run: make clean

src/Grade.cpp

@@ -9,6 +9,7 @@
 /**
  * Default constructor
  *
+ * @return void
  */
 Grade::Grade() { _grade = 0.0; }
 
@@ -29,6 +30,7 @@ Grade::Grade(const Grade &other) { _grade = other._grade; }
 /**
  * Destructor
  *
+ * @return void
  */
 Grade::~Grade() {
   // Do nothing.

src/Grade.h

@@ -28,6 +28,7 @@ class Grade {
   /**
    * Default constructor
    *
+   * @return void
    */
   Grade();
 
@@ -48,6 +49,7 @@ class Grade {
   /**
    * Destructor
    *
+   * @return void
    */
   ~Grade();
 

src/InputHelper.cpp

@@ -6,10 +6,20 @@
 
 #include "InputHelper.h"
 
+/**
+ * InputHelper default constructor
+ *
+ * @return void
+ */
 InputHelper::InputHelper() {
   // Do nothing
 }
 
+/**
+ * InputHelper destructor
+ *
+ * @return void
+ */
 InputHelper::~InputHelper() {
   // Do nothing
 }

src/InputHelper.h

@@ -24,16 +24,26 @@ enum { ALLOW_PARSING_ERROR = 1 << 0, IGNORE_PARSING_ERROR = 1 << 1 };
 }
 
 /**
- * InputHelper
+ * InputHelper class
  *
  */
 class InputHelper {
  private:
   int _inputFlag = 0;
 
+  /**
+   * InputHelper default constructor
+   *
+   * @return void
+   */
   InputHelper();
 
  public:
+  /**
+   * InputHelper destructor
+   *
+   * @return void
+   */
   ~InputHelper();
 
   /**

src/OutputHelper.cpp

@@ -6,10 +6,20 @@
 
 #include "OutputHelper.h"
 
+/**
+ * OutputHelper default constructor
+ *
+ * @return void
+ */
 OutputHelper::OutputHelper() {
   // Do nothing
 }
 
+/**
+ * OutputHelper destructor
+ *
+ * @return void
+ */
 OutputHelper::~OutputHelper() {
   // Do nothing
 }
@@ -53,6 +63,7 @@ void OutputHelper::setOutputFlag(int flag) { _outputFlag |= flag; }
 /**
  * Print the textart
  *
+ * @return void
  */
 void OutputHelper::printTextart() {
   std::ifstream textartFile(OutputConstants::TEXTART_FILE);
@@ -70,6 +81,7 @@ void OutputHelper::printTextart() {
 /**
  * Print a separator line.
  *
+ * @return void
  */
 void OutputHelper::printSeparator() {
   std::cout << std::setfill('-');
@@ -129,8 +141,8 @@ void OutputHelper::printTable(
 
   /**
    * Output in table format
-   * (without last conclusion row)
    *
+   * (without last conclusion row)
    */
   if (!isCSVOutput()) {
     printTableFormat(tableData);

src/OutputHelper.h

@@ -36,16 +36,26 @@ enum {
 };
 }  // namespace OutputConstants
 
+/**
+ * OutputHelper class
+ *
+ */
 class OutputHelper {
  private:
   int _outputFlag = 0;
 
+  /**
+   * OutputHelper default constructor
+   *
+   * @return void
+   */
   OutputHelper();
 
  private:
   /**
    * Print a separator line.
    *
+   * @return void
    */
   void printSeparator();
 
@@ -78,6 +88,11 @@ class OutputHelper {
   void printTableFormat(const std::vector<std::vector<std::string>> &);
 
  public:
+  /**
+   * OutputHelper destructor
+   *
+   * @return void
+   */
   ~OutputHelper();
 
   /**
@@ -112,6 +127,7 @@ class OutputHelper {
   /**
    * Print the textart
    *
+   * @return void
    */
   void printTextart();
 

src/PersonalExcept.cpp

@@ -6,10 +6,20 @@
 
 #include "PersonalExcept.h"
 
+/**
+ * PersonalExcept default constructor
+ *
+ * @return void
+ */
 PersonalExcept::PersonalExcept() {
   // Do nothing.
 }
 
+/**
+ * PersonalExcept destructor
+ *
+ * @return void
+ */
 PersonalExcept::~PersonalExcept() {
   // Do nothing.
 }

src/PersonalExcept.h

@@ -23,8 +23,18 @@ class PersonalExcept : public PersonalGPA {
   std::multiset<std::string> _ignoredCourses;
 
  public:
+  /**
+   * PersonalExcept default constructor
+   *
+   * @return void
+   */
   PersonalExcept();
 
+  /**
+   * PersonalExcept destructor
+   *
+   * @return void
+   */
   ~PersonalExcept();
 
   /**

src/PersonalFactory.cpp

@@ -6,6 +6,12 @@
 
 #include "PersonalFactory.h"
 
+/**
+ * PersonalFactory default constructor
+ * This will push prototypes (classes) to a list - to create later.
+ *
+ * @return void
+ */
 PersonalFactory::PersonalFactory() {
   // Push list of prototypes.
   _prototypes.push_back(std::make_shared<PersonalGPA>());
@@ -14,8 +20,9 @@ PersonalFactory::PersonalFactory() {
 }
 
 /**
- * Destructor
+ * PersonalFactory destructor
  *
+ * @return void
  */
 PersonalFactory::~PersonalFactory() {
   // Do nothing.

src/PersonalFactory.h

@@ -19,13 +19,18 @@ class PersonalFactory {
   // List of prototypes.
   std::vector<std::shared_ptr<PersonalGPA>> _prototypes;
 
-  // Setting up.
+  /**
+   * PersonalFactory default constructor
+   *
+   * @return void
+   */
   PersonalFactory();
 
  public:
   /**
-   * Destructor
+   * PersonalFactory destructor
    *
+   * @return void
    */
   ~PersonalFactory();
 

src/PersonalGPA.cpp

@@ -7,16 +7,18 @@
 #include "PersonalGPA.h"
 
 /**
- * Constructor for PersonalGPA
+ * PersonalGPA default constructor
  *
+ * @return void
  */
 PersonalGPA::PersonalGPA() {
   // Do nothing;
 }
 
 /**
- * Destructor for PersonalGPA
+ * PersonalGPA destructor
  *
+ * @return void
  */
 PersonalGPA::~PersonalGPA() {
   // Do nothing;

src/PersonalGPA.h

@@ -35,14 +35,16 @@ class PersonalGPA {
 
  public:
   /**
-   * Constructor for PersonalGPA
+   * PersonalGPA default constructor
    *
+   * @return void
    */
   PersonalGPA();
 
   /**
-   * Destructor for PersonalGPA
+   * PersonalGPA destructor
    *
+   * @return void
    */
   ~PersonalGPA();
 

src/PersonalSpecific.cpp

@@ -6,10 +6,20 @@
 
 #include "PersonalSpecific.h"
 
+/**
+ * PersonalSpecific default constructor
+ *
+ * @return void
+ */
 PersonalSpecific::PersonalSpecific() {
   // Do nothing
 }
 
+/**
+ * PersonalSpecific destructor
+ *
+ * @return void
+ */
 PersonalSpecific::~PersonalSpecific() {
   // Do nothing
 }

src/PersonalSpecific.h

@@ -20,8 +20,18 @@
  */
 class PersonalSpecific : public PersonalGPA {
  public:
+  /**
+   * PersonalSpecific default constructor
+   *
+   * @return void
+   */
   PersonalSpecific();
 
+  /**
+   * PersonalSpecific destructor
+   *
+   * @return void
+   */
   ~PersonalSpecific();
 
   /**