]> Creatis software - crea.git/commitdiff
Feature #1711
authorDaniel Gonzalez <daniel.gonzalez@creatis.insa-lyon.fr>
Thu, 31 Jan 2013 16:18:00 +0000 (17:18 +0100)
committerDaniel Gonzalez <daniel.gonzalez@creatis.insa-lyon.fr>
Thu, 31 Jan 2013 16:18:00 +0000 (17:18 +0100)
CreaDevManager application implementation

- Documentation adjustments

lib/creaDevManagerLib/CDMUtilities.h
lib/creaDevManagerLib/modelCDMProject.h
lib/creaDevManagerLib/wxCDMTreeItemId.h

index 02c3b8285d7d852d76d9139fe21a068e9c3c0ee2..99dd04c4a8e034a13f6427cbb9c74eefdb59edc7 100644 (file)
@@ -171,7 +171,7 @@ namespace CDMUtilities
    */
   bool createEmptyClass(const std::string& name, const std::string& path);
   /**
-   * Creates a string replacing each \ by \\.
+   * Creates a string replacing each \ by double \ .
    * @param line String to stringify.
    * @return line stringified.
    */
index 085d9e4f6e75dd2b2de966e697e6f4bee9c9e25f..5df1550a28c11c0fafe6b146472bdba5342a8336 100644 (file)
@@ -176,6 +176,7 @@ 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.
@@ -240,6 +241,7 @@ 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, const std::string& folder);
index f334a4027cdbb18c855bbec28b07729e293ad405..0f714003bf369f71537824f5f4fa37986e00d596 100644 (file)
@@ -80,19 +80,19 @@ public :
 
   /**
    * Operator ==
-   * @id comparing tree item id
+   * @param id comparing tree item id
    * @return true if the id value is the same.
    */
   bool operator == (const wxCDMTreeItemId& id) const;
   /**
    * Operator !=
-   * @id comparing tree item id
+   * @param id comparing tree item id
    * @return true if the id value is not the same.
    */
   bool operator != (const wxCDMTreeItemId& id) const;
   /**
    * Operator <
-   * @id comparing tree item id
+   * @param id comparing tree item id
    * @return true if the id value is less than the one in the given id.
    */
   bool operator < (const wxCDMTreeItemId& id) const;