X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FcreaDevManagerLib%2FmodelCDMFolder.h;h=2a44830c04e91e33c4cf50ab200d29e617517e76;hb=72a6140565ccd0905f822c7bf17ea471762a9301;hp=383f89d5deb5be8e421b86f568fe241e1ca9449c;hpb=d8222afd6508f39bd37426842667de2e431cca4a;p=crea.git

diff --git a/lib/creaDevManagerLib/modelCDMFolder.h b/lib/creaDevManagerLib/modelCDMFolder.h
index 383f89d..2a44830 100644
--- a/lib/creaDevManagerLib/modelCDMFolder.h
+++ b/lib/creaDevManagerLib/modelCDMFolder.h
@@ -41,29 +41,85 @@
 #include "modelCDMIProjectTreeNode.h"
 #include "modelCDMCMakeListsFile.h"
 
+/**
+ * Class representing a folder in the project hierarchy.
+ */
 class modelCDMFolder : public modelCDMIProjectTreeNode
 {
 public:
+  /**
+   * Default constructor.
+   */
   modelCDMFolder();
-  modelCDMFolder(const std::string& path, const int& level = 3);
+  /**
+   * Constructor of the folder node.
+   * @param parent Parent node.
+   * @param path Full path of the folder node.
+   * @param name Folder name of the folder node.
+   * @param level Hierarchy level of the folder node in the project.
+   */
+  modelCDMFolder(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const int& level = 3);
+  /**
+   * Destructor.
+   */
   ~modelCDMFolder();
 
+  /**
+   * Returns the reference to the folder node's CMakeLists file if it exists.
+   * @return Reference to the CMakeLists file or NULL.
+   */
   modelCDMCMakeListsFile* GetCMakeLists() const;
+  /**
+   * Returns an array with the containing folder children of the actual folder node.
+   * @return Array with references to children folder nodes.
+   */
   std::vector<modelCDMFolder*> GetFolders() const;
 
-  bool CreateFolder(
+  /**
+   * Creates a class (.h and .cpp files) in the folder node. It creates the files in the model as well as in the system.
+   * @param name Name of the class to create.
+   * @return True if the operation was successful.
+   */
+  bool CreateClass(const std::string& name);
+
+  /**
+   * Creates a folder in the folder node. It creates the folder in the model as well as in the system.
+   * @param name Name of the folder to create.
+   * @param result Result message of the operation.
+   * @return True if the operation was successful.
+   */
+  modelCDMFolder* CreateFolder(
       const std::string& name,
-      std::string*& result,
-      const std::string& path = "/"
+      std::string*& result
   );
+  /**
+   * Opens the CMakeLists file in the default code editor.
+   * @param result Result message of the operation.
+   * @return True if the operation was successful.
+   */
   bool OpenCMakeListsFile(std::string* & result);
+  /**
+   * Refreshes the folder node structure. deletes deleted files and folders, and adds created files and folders.
+   * @param result Result message of the operation
+   * @return True if the operation was successful.
+   */
   virtual const bool Refresh(std::string*& result);
 
+  /**
+   * Returns wether the CMakeLists attribute is different from NULL or not.
+   * @return True if the MakeLists attribute is different from NULL.
+   */
   bool HasCMakeLists();
 
 protected:
+  /**
+   * Reference to the folder node's CMakeLists.
+   */
   modelCDMCMakeListsFile* CMakeLists;
 private:
+  /**
+   * Reference array to the children folders.
+   */
   std::vector<modelCDMFolder*> folders;
 
 };