(svn r23363) -Documentation: document a tiny bit better what is in variables

This commit is contained in:
truebrain 2011-11-29 23:21:59 +00:00
parent e37149a1de
commit c38c16773c
3 changed files with 5 additions and 5 deletions

View File

@ -103,14 +103,14 @@ protected:
HSQOBJECT *SQ_instance; ///< The Squirrel instance created for this info.
private:
char *main_script; ///< Name of the main script.
char *main_script; ///< The full path of the script.
char *tar_file; ///< If, which tar file the script was in.
const char *author; ///< Author of the script.
const char *name; ///< Full name of the script.
const char *short_name; ///< Short name (4 chars) which uniquely identifies the script.
const char *description; ///< Small description of the script.
const char *date; ///< The date the script was written at.
const char *instance_name; ///< Which instance name the script has.
const char *instance_name; ///< Name of the main class in the script.
int version; ///< Version of the script.
const char *url; ///< URL of the script.

View File

@ -31,7 +31,7 @@ public:
/**
* Initialize the script and prepare it for its first run.
* @param main_script The name of the script to load.
* @param main_script The full path of the script to load.
* @param instance_name The name of the instance out of the script to load.
*/
void Initialize(const char *main_script, const char *instance_name);

View File

@ -82,8 +82,8 @@ public:
protected:
class Squirrel *engine; ///< The engine we're scanning with.
char *main_script; ///< The name of the current main script.
char *tar_file; ///< The filename of the tar for the main script.
char *main_script; ///< The full path of the script.
char *tar_file; ///< If, which tar file the script was in.
ScriptInfoList info_list; ///< The list of all script.
ScriptInfoList info_single_list; ///< The list of all unique script. The best script (highest version) is shown.