Browse Source

Adding doc strings for public methods

Josh Engebretson 8 years ago
parent
commit
f4c20b0324
1 changed files with 3 additions and 0 deletions
  1. 3 0
      Source/ToolCore/Command/Command.h

+ 3 - 0
Source/ToolCore/Command/Command.h

@@ -49,6 +49,7 @@ public:
     Command(Context* context);
     Command(Context* context);
     virtual ~Command();
     virtual ~Command();
 
 
+    /// Parse a command from given arguments and startIndex, return false on failure with errorMsg set
     bool Parse(const Vector<String>& arguments, unsigned startIndex, String& errorMsg);
     bool Parse(const Vector<String>& arguments, unsigned startIndex, String& errorMsg);
 
 
     virtual void Run() = 0;
     virtual void Run() = 0;
@@ -61,8 +62,10 @@ public:
 
 
     virtual bool RequiresProjectLoad() { return true; }
     virtual bool RequiresProjectLoad() { return true; }
 
 
+    /// Loads project into ToolSystem returning true on success
     bool LoadProject();
     bool LoadProject();
 
 
+    /// Returns the project path specified by the --project common argument
     virtual const String& GetProjectPath() const { return projectPath_; }
     virtual const String& GetProjectPath() const { return projectPath_; }
 
 
     virtual bool RequiresLicenseValidation() { return false; }
     virtual bool RequiresLicenseValidation() { return false; }