]> Creatis software - crea.git/blobdiff - lib/creaDevManagerLib/modelCDMProject.h
Feature #1711
[crea.git] / lib / creaDevManagerLib / modelCDMProject.h
index 7e69c799fbcdd0000b252f4df7fc8c3b9a890852..5df1550a28c11c0fafe6b146472bdba5342a8336 100644 (file)
@@ -59,7 +59,9 @@ public:
 
   /**
    * Constructor receiving the source path and the build path.
+   * @param parent Parent node of the Project node.
    * @param path The source path.
+   * @param name Name of the project folder.
    * @param buildPath The build path. By default it's an empty string.
    */
   modelCDMProject(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const std::string& buildPath = "");
@@ -174,12 +176,14 @@ public:
   /**
    * Creates an application and sets it as a children of the appli folder in the project. This method creates the library in the hard drive and also in the model.
    * @param name Application name.
+   * @param type Application type. 0=console application, 1=GUI application (wxWidgets).
    * @param result Result of the operation.
    * @param path Path of the application if not in the application folder. This parameter is not used (for now).
    * @return The result of the creation. If everything goes well it returns true, else it returns false.
    */
   modelCDMIProjectTreeNode* CreateApplication(
       const std::string& name,
+      const int& type,
       std::string*& result,
       const std::string& path = "/appli"
   );
@@ -229,6 +233,7 @@ public:
   /**
    * Launches in console the make -clean and make commands to build the project.
    * @param result Result message for building the project.
+   * @param line Line to execute the compilation.
    * @return if any of the commands cannot be executed it return false.
    */
   bool Build(std::string*& result, const std::string& line);
@@ -236,9 +241,10 @@ public:
   /**
    * Launches in console the bbPlugPackage command to connect the project to the .bbtk folder in the hard drive.
    * @param result Result message for connecting the project.
+   * @param folder Folder to make connection with. It must contain the bbtkPackage file
    * @return if the command cannot be executed it return false.
    */
-  bool Connect(std::string*& result);
+  bool Connect(std::string*& result, const std::string& folder);
 
   /**
    * Checks the CMakeLists files to see what's going to be compiled and what's not.
@@ -249,13 +255,34 @@ public:
 
 private:
 
+  /**
+   * Project Name
+   */
   std::string nameProject;
+  /**
+   * Project Version
+   */
   std::string version;
+  /**
+   * Last Project Version Modification Date
+   */
   std::string versionDate;
+  /**
+   * Build Path for compiling the project
+   */
   std::string buildPath;
 
+  /**
+   * lib folder
+   */
   modelCDMLib* lib;
+  /**
+   * appli folder
+   */
   modelCDMAppli* appli;
+  /**
+   * package folders
+   */
   std::vector<modelCDMPackage*> packages;
 
 };