From 3e4f251c978672bd542f132e255d08b75eea52d1 Mon Sep 17 00:00:00 2001 From: Daniel Gonzalez Date: Thu, 31 Jan 2013 17:18:00 +0100 Subject: [PATCH] Feature #1711 CreaDevManager application implementation - Documentation adjustments --- lib/creaDevManagerLib/CDMUtilities.h | 2 +- lib/creaDevManagerLib/modelCDMProject.h | 2 ++ lib/creaDevManagerLib/wxCDMTreeItemId.h | 6 +++--- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/lib/creaDevManagerLib/CDMUtilities.h b/lib/creaDevManagerLib/CDMUtilities.h index 02c3b82..99dd04c 100644 --- a/lib/creaDevManagerLib/CDMUtilities.h +++ b/lib/creaDevManagerLib/CDMUtilities.h @@ -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. */ diff --git a/lib/creaDevManagerLib/modelCDMProject.h b/lib/creaDevManagerLib/modelCDMProject.h index 085d9e4..5df1550 100644 --- a/lib/creaDevManagerLib/modelCDMProject.h +++ b/lib/creaDevManagerLib/modelCDMProject.h @@ -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); diff --git a/lib/creaDevManagerLib/wxCDMTreeItemId.h b/lib/creaDevManagerLib/wxCDMTreeItemId.h index f334a40..0f71400 100644 --- a/lib/creaDevManagerLib/wxCDMTreeItemId.h +++ b/lib/creaDevManagerLib/wxCDMTreeItemId.h @@ -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; -- 2.47.1