From c38c16773ca0bc5c928486b18318eb5b147f8ff0 Mon Sep 17 00:00:00 2001 From: truebrain Date: Tue, 29 Nov 2011 23:21:59 +0000 Subject: (svn r23363) -Documentation: document a tiny bit better what is in variables --- src/script/script_info.hpp | 4 ++-- src/script/script_instance.hpp | 2 +- src/script/script_scanner.hpp | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) (limited to 'src') diff --git a/src/script/script_info.hpp b/src/script/script_info.hpp index c19478116..1e118f164 100644 --- a/src/script/script_info.hpp +++ b/src/script/script_info.hpp @@ -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. diff --git a/src/script/script_instance.hpp b/src/script/script_instance.hpp index 21edf981a..c5ff730c7 100644 --- a/src/script/script_instance.hpp +++ b/src/script/script_instance.hpp @@ -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); diff --git a/src/script/script_scanner.hpp b/src/script/script_scanner.hpp index ac9b25fdc..e0788b605 100644 --- a/src/script/script_scanner.hpp +++ b/src/script/script_scanner.hpp @@ -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. -- cgit v1.2.3-54-g00ecf