Feature #1711 CreaDevManager application implementation

[crea.git] / lib / creaDevManagerLib / modelCDMCMakeListsFile.h

diff --git a/lib/creaDevManagerLib/modelCDMCMakeListsFile.h b/lib/creaDevManagerLib/modelCDMCMakeListsFile.h
index 65f034fb86b3b6bd22888392ba84f32496ad58d6..5d51e3dcd5008fc5b2970670fcb8667a3d924990 100644 (file)
--- a/lib/creaDevManagerLib/modelCDMCMakeListsFile.h
+++ b/lib/creaDevManagerLib/modelCDMCMakeListsFile.h
@@ -37,14 +37,40 @@
 
 #include "modelCDMFile.h"
 
+/**
+ * Class representing the CMakeLists.txt file in a folder of a Crea project.
+ */
 class modelCDMCMakeListsFile : public modelCDMFile
 {
 public:
+  /**
+   * Default Constructor.
+   */
   modelCDMCMakeListsFile();
-  modelCDMCMakeListsFile(const std::string& path, const std::string& name = "CMakeLists.txt", const int& level = 1);
+  /**
+   * CMakeLists file Constructor.
+   * @param parent Parent node of the CMakeLists file node.
+   * @param path Full path to the CMakeLists file node.
+   * @param name File name of the CMakeLists file node.
+   * @param level Project hierarchy level of the CMakeLists file node.
+   */
+  modelCDMCMakeListsFile(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name = "CMakeLists.txt", const int& level = 1);
+  /**
+   * Destructor
+   */
   ~modelCDMCMakeListsFile();
 
+  /**
+   * Opens the file in the system default code editor.
+   * @param result Result message.
+   * @return True if the operation was successful.
+   */
   bool OpenFile(std::string*& result);
+  /**
+   * Refreshes the state of the CMakeLists file.
+   * @param result Result message.
+   * @return True if the operation was successful.
+   */
   virtual const bool Refresh(std::string*& result);
 };