cleaning up formatting mostly

include/task/task.hpp

@@ -62,24 +62,25 @@ class Task;
 /**
  * Aliases
  */
+using TaskQueue = QQueue<Task*>;
 using ArgumentType = const char*;
+using ArgumentValues = QVector<const QString>;
 using TypeVariant = std::variant<bool, int, QString, QVector<QString>, std::vector<KFileData>>;
 using TaskIterator = std::vector<std::unique_ptr<TaskArgumentBase>>::iterator;
 using TaskArguments = std::vector<std::unique_ptr<TaskArgumentBase>>;
-using TaskQueue = QQueue<Task*>;
-using ArgumentValues = QVector<const QString>;
 
 /**
  * The interface expected on our Task Arguments
  */
 class TaskArgumentBase {
  public:
-  virtual void setValue(TypeVariant v) = 0;
-  virtual TypeVariant getValue() = 0;
   virtual const QString text() = 0;
-  virtual void clear() = 0;
   virtual const QString getStringValue() = 0;
+  virtual TypeVariant getValue() = 0;
+  virtual void setValue(TypeVariant v) = 0;
   virtual bool isContainer() = 0;
+  virtual void clear() = 0;
+
 };
 
 /**
@@ -102,7 +103,8 @@ class TaskArgument : TaskArgumentBase {
    * @constructor
    * @param [in] {TaskArgument&&} a The R-value reference to a TaskArgument
    */
-  TaskArgument(TaskArgument&& a) : name(std::move(a.name)), type(std::move(a.type)), value(std::move(a.value)) {}
+  TaskArgument(TaskArgument&& a) :
+    name(std::move(a.name)), type(std::move(a.type)), value(std::move(a.value)) {}
   /**
    * text
    * @returns {QString} The name of the argument
@@ -115,6 +117,10 @@ class TaskArgument : TaskArgumentBase {
    */
   virtual void setValue(TypeVariant new_value) override { value = new_value; }
 
+  /**
+   * @brief getStringValue
+   * @return [out] {QString}
+   */
   virtual const QString getStringValue() override {
     if (isIndex(value.index(), VariantIndex::QSTRING)) {
       return std::get<VariantIndex::QSTRING>(value);
@@ -125,6 +131,10 @@ class TaskArgument : TaskArgumentBase {
     }
   }
 
+  /**
+   * @brief getValue
+   * @return [out] {TypeVariant}
+   */
   virtual TypeVariant getValue() override {
     if (isIndex(value.index(), VariantIndex::QSTRING)) {
       return std::get<VariantIndex::QSTRING>(value);
@@ -135,6 +145,9 @@ class TaskArgument : TaskArgumentBase {
     }
   }
 
+  /**
+   * @brief clear
+   */
   virtual void clear() override {
     if (isIndex(value.index(), VariantIndex::STRVEC)) {
       std::get<VariantIndex::STRVEC>(value).clear();
@@ -145,10 +158,14 @@ class TaskArgument : TaskArgumentBase {
     } else if (isIndex(value.index(), VariantIndex::INTEGER)) {
       std::get<VariantIndex::INTEGER>(value) = 0;
     } else if (isIndex(value.index(), VariantIndex::BOOLEAN)) {
-      std::get<VariantIndex::STRVEC>(value) = false;
+      std::get<VariantIndex::BOOLEAN>(value) = false;
     }
   }
 
+  /**
+   * @brief isContainer
+   * @return [out] {bool}
+   */
   virtual bool isContainer() override {
     return (isIndex(value.index(), VariantIndex::STRVEC) || isIndex(value.index(), VariantIndex::FILEVEC));
   }

src/instagram_task.cpp

@@ -16,29 +16,55 @@ static const uint8_t USER = 9;
 static const uint8_t IS_VIDEO = 10;
 }  // namespace TaskIndex
 
+/**
+ * @constructor
+ * @param [in] {KFileData} k_file
+ */
 InstagramTask::InstagramTask(KFileData k_file) : files({k_file}) {}
+
+/**
+ * @constructor
+ * @param [in] {QVector<KFileData>} k_files
+ */
 InstagramTask::InstagramTask(QVector<KFileData> k_files) : files(k_files) {}
 
+/**
+ * @brief InstagramTask::defineTaskArguments
+ */
 void InstagramTask::defineTaskArguments() {
   std::vector<std::unique_ptr<TaskArgumentBase>> args{};
-  args.emplace_back(std::make_unique<TaskArgument<QString>>("header", Type::TEXT, QString{}));
-  args.emplace_back(std::make_unique<TaskArgument<QString>>("description", Type::TEXT, QString{}));
-  args.emplace_back(std::make_unique<TaskArgument<QString>>("datetime", Type::DATETIME, QString{}));
-  args.emplace_back(std::make_unique<TaskArgument<QString>>("promote_share", Type::TEXT, QString{}));
-  args.emplace_back(std::make_unique<TaskArgument<QString>>("link_in_bio", Type::TEXT, QString{}));
-  args.emplace_back(std::make_unique<TaskArgument<QString>>("hashtags", Type::TEXT, QString{}));
-  args.emplace_back(
-      std::make_unique<TaskArgument<std::vector<QString>>>("requested_by", Type::STRINGVECTOR, std::vector<QString>{}));
-  args.emplace_back(std::make_unique<TaskArgument<QString>>("requested_by_phrase", Type::TEXT, QString{}));
-  args.emplace_back(
-      std::make_unique<TaskArgument<std::vector<KFileData>>>("files", Type::FILEVECTOR, std::vector<KFileData>{})),
-      args.emplace_back(std::make_unique<TaskArgument<QString>>("user", Type::TEXT, QString{}));
-  args.emplace_back(std::make_unique<TaskArgument<bool>>("is_video", Type::BOOLEAN, bool{}));
+  args.emplace_back(std::make_unique<
+                    TaskArgument<QString>>("header", Type::TEXT, QString{}));
+  args.emplace_back(std::make_unique<
+                    TaskArgument<QString>>("description", Type::TEXT, QString{}));
+  args.emplace_back(std::make_unique<
+                    TaskArgument<QString>>("datetime", Type::DATETIME, QString{}));
+  args.emplace_back(std::make_unique<
+                    TaskArgument<QString>>("promote_share", Type::TEXT, QString{}));
+  args.emplace_back(std::make_unique<
+                    TaskArgument<QString>>("link_in_bio", Type::TEXT, QString{}));
+  args.emplace_back(std::make_unique<
+                    TaskArgument<QString>>("hashtags", Type::TEXT, QString{}));
+  args.emplace_back(std::make_unique<
+                    TaskArgument<
+                        std::vector<QString>>>("requested_by", Type::STRINGVECTOR, std::vector<QString>{}));
+  args.emplace_back(std::make_unique<
+                    TaskArgument<QString>>("requested_by_phrase", Type::TEXT, QString{}));
+  args.emplace_back(std::make_unique<
+                    TaskArgument<
+                        std::vector<KFileData>>>("files", Type::FILEVECTOR, std::vector<KFileData>{})),
+  args.emplace_back(std::make_unique<
+                    TaskArgument<QString>>("user", Type::TEXT, QString{}));
+  args.emplace_back(std::make_unique<
+                    TaskArgument<bool>>("is_video", Type::BOOLEAN, bool{}));
   m_arguments = args;
 }
 
-const TaskArguments InstagramTask::getTaskArguments() { return m_arguments; }
-
+/**
+ * @brief InstagramTask::setArgument
+ * @param name
+ * @param value
+ */
 void InstagramTask::setArgument(QString name, TypeVariant value) {
   TaskIterator it =
       std::find_if(m_arguments.begin(), m_arguments.end(), [name](auto argument) { return argument.text() == name; });
@@ -56,6 +82,11 @@ void InstagramTask::setArgument(QString name, TypeVariant value) {
   }
 }
 
+/**
+ * @brief InstagramTask::getTaskArgument
+ * @param name
+ * @return
+ */
 TypeVariant InstagramTask::getTaskArgument(QString name) {
   TaskIterator it =
       std::find_if(m_arguments.begin(), m_arguments.end(), [name](auto argument) { return argument.text() == name; });
@@ -65,6 +96,10 @@ TypeVariant InstagramTask::getTaskArgument(QString name) {
   return "";  // Perhaps we should throw
 }
 
+/**
+ * @brief InstagramTask::getArgumentValues
+ * @return
+ */
 ArgumentValues InstagramTask::getArgumentValues() {
   ArgumentValues values{static_cast<int>(m_arguments.size())};
   for (const auto& argument : m_arguments) {
@@ -75,23 +110,49 @@ ArgumentValues InstagramTask::getArgumentValues() {
   return values;
 }
 
+/**
+ * @brief InstagramTask::getTaskArguments
+ * @return
+ */
+const TaskArguments InstagramTask::getTaskArguments() { return m_arguments; }
+
+
+/**
+ * @brief InstagramTask::getFiles
+ * @return
+ */
 const QVector<KFileData> InstagramTask::getFiles() { return files; }
 
+/**
+ * @brief InstagramTask::setDefaultValues
+ */
 void InstagramTask::setDefaultValues() {
-  m_arguments.at(TaskIndex::HEADER)->setValue("Learn to speak like native Korean speakers 🙆‍♀️🇰🇷");
+  m_arguments.at(TaskIndex::HEADER)
+      ->setValue("Learn to speak like native Korean speakers 🙆‍♀️🇰🇷");
   m_arguments.at(TaskIndex::PROMOTE_SHARE)
       ->setValue("Share the post through IG story if you enjoy the phrase 🙋‍♀️");
   m_arguments.at(TaskIndex::LINK_IN_BIO)
       ->setValue("Subscribe to my YouTube channel (link 🔗in bio) to learn more about Korean language and culture ❤");
-  m_arguments.at(TaskIndex::REQUESTED_BY_PHRASE)->setValue("The phrase was requested by ");
+  m_arguments.at(TaskIndex::REQUESTED_BY_PHRASE)
+      ->setValue("The phrase was requested by ");
 }
 
+/**
+ * @brief getType
+ * @return {Scheduler::TaskType} The type of task
+ */
 Scheduler::TaskType getType() { return Scheduler::TaskType::INSTAGRAM; };
 
+/**
+ * @brief InstagramTask::clear
+ */
 void InstagramTask::clear() {
   for (const auto& argument : m_arguments) {
     argument->clear();
   }
 }
 
+/**
+ * @destructor
+ */
 InstagramTask::~InstagramTask() {}