X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;ds=sidebyside;f=lib%2FcreaDevManagerLib%2FmodelCDMPackage.h;fp=lib%2FcreaDevManagerLib%2FmodelCDMPackage.h;h=05e24739014b69c8752d840ec9e57bb4a9b8b63d;hb=c1c0272929da71783e2d520a24acfb23fe8e24a5;hp=471dbb35f6836e5d0f9e06a276d47375b8aeb813;hpb=2fb5dd9262993efaf56bfc731f4297fdb96bf63e;p=crea.git

diff --git a/lib/creaDevManagerLib/modelCDMPackage.h b/lib/creaDevManagerLib/modelCDMPackage.h
index 471dbb3..05e2473 100644
--- a/lib/creaDevManagerLib/modelCDMPackage.h
+++ b/lib/creaDevManagerLib/modelCDMPackage.h
@@ -42,26 +42,102 @@
 #include"modelCDMFolder.h"
 #include"modelCDMPackageSrc.h"
 
+/**
+ * Class representing a package of a Crea project.
+ */
 class modelCDMPackage : public modelCDMFolder
 {
 public:
+  /**
+   * Default constructor.
+   */
   modelCDMPackage();
+  /**
+   * Package node constructor.
+   * @param parent Parent node of the package folder node.
+   * @param path Full path to the package.
+   * @param name Name of the package folder.
+   * @param level Project hierarchy level of the package node.
+   */
   modelCDMPackage(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const int& level = 1);
+  /**
+   * Destructor.
+   */
   ~modelCDMPackage();
 
+  /**
+   * Retrieves the name of the package. the name of the package can be different from the package folder name.
+   * @return Package name.
+   */
   const std::string& GetNamePackage() const;
+  /**
+   * Retrieves the authors of the package.
+   * @return Package authors.
+   */
   const std::string& GetAuthors() const;
+  /**
+   * Retrieves the Author e-mails of the package.
+   * @return Author e-mails.
+   */
   const std::string& GetAuthorsEmail() const;
+  /**
+   * Retrieves the version of the package.
+   * @return Package version.
+   */
   const std::string& GetVersion() const;
+  /**
+   * Retrieves the description of the package.
+   * @return Package description
+   */
   const std::string& GetDescription() const;
+  /**
+   * Retrieves the src folder node of the package node.
+   * @return Reference to the package src file node.
+   */
   modelCDMPackageSrc* GetSrc() const;
 
+  /**
+   * Sets the name of the package authors. This operation affects the project model as well as the system files.
+   * @param authors Name of the package authors.
+   * @param result Result message
+   * @return True if the operation was successful.
+   */
   bool SetAuthors(const std::string& authors, std::string*& result);
+  /**
+   * Sets the email of the package authors. This operation affects the project model as well as the system files.
+   * @param email
+   * @param result Result message
+   * @return True if the operation was successful.
+   */
   bool SetAuthorsEmail(const std::string& email, std::string*& result);
+  /**
+   * Sets the version of the package. This operation affects the project model as well as the system files.
+   * @param version
+   * @param result Result message
+   * @return True if the operation was successful.
+   */
   bool SetVersion(const std::string& version, std::string*& result);
+  /**
+   * Sets the description of the package. This operation affects the project model as well as the system files.
+   * @param description
+   * @param result Result message
+   * @return True if the operation was successful.
+   */
   bool SetDescription(const std::string& description, std::string*& result);
 
 
+  /**
+   * Creates a new black box and returns a reference to it if the creation is successful. This operation affects the project model as well as the system files.
+   * @param result Result message
+   * @param name New black box name.
+   * @param type Black box type.
+   * @param format Black box format.
+   * @param categories Categories associated to this black box.
+   * @param authors Black box authors' name.
+   * @param authorsEmail Black box authors' email.
+   * @param description Black box description.
+   * @return True if the operation was successful.
+   */
   modelCDMBlackBox* CreateBlackBox(
       std::string*& result,
       const std::string& name,
@@ -72,16 +148,43 @@ public:
       const std::string& authorsEmail = "",
       const std::string& description = "no description"
   );
+  /**
+   * Refreshes the structure of the package folder node. This method updates the properties of the package as well as it refreshes its children.
+   * @param result Result message
+   * @return True if the operation was successful.
+   */
   virtual const bool Refresh(std::string*& result);
 
+  /**
+   * Checks the package structure with the CMakeLists file to look for project structure definition problems before compiling the project.
+   * @param properties Project properties.
+   */
   void CheckStructure(std::map<std::string, bool>& properties);
 
 private:
+  /**
+   * Package name.
+   */
   std::string namePackage;
+  /**
+   * Package authors' name.
+   */
   std::string authors;
+  /**
+   * Package authors' e-mails.
+   */
   std::string authorsEmail;
+  /**
+   * Package version.
+   */
   std::string version;
+  /**
+   * Package description.
+   */
   std::string description;
+  /**
+   * Reference to the package source folder.
+   */
   modelCDMPackageSrc* src;
 
 };