summaryrefslogtreecommitdiff
path: root/src/script
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2011-05-01 19:51:52 +0000
committerrubidium <rubidium@openttd.org>2011-05-01 19:51:52 +0000
commit5a620d1c6592057b500f0889eef8949dc1e95e4b (patch)
treedabae6247490fdea860bea292bb8eee49ce46fe4 /src/script
parent1a515e6344028854c855671c19f49d8f869eb18f (diff)
downloadopenttd-5a620d1c6592057b500f0889eef8949dc1e95e4b.tar.xz
(svn r22406) -Document: some more "random-ish" tidbits
Diffstat (limited to 'src/script')
-rw-r--r--src/script/script_scanner.hpp5
-rw-r--r--src/script/squirrel_helper_type.hpp5
2 files changed, 6 insertions, 4 deletions
diff --git a/src/script/script_scanner.hpp b/src/script/script_scanner.hpp
index e8f5efb77..415b7f6db 100644
--- a/src/script/script_scanner.hpp
+++ b/src/script/script_scanner.hpp
@@ -14,6 +14,7 @@
#include "../fileio_type.h"
+/** Scanner to help finding scripts. */
class ScriptScanner {
public:
ScriptScanner();
@@ -43,8 +44,8 @@ private:
void ScanDir(const char *dirname, const char *info_file_name);
protected:
- class Squirrel *engine;
- char main_script[1024];
+ class Squirrel *engine; ///< The engine we're scanning with.
+ char main_script[1024]; ///< The name of the current main script.
};
#endif /* SCRIPT_SCANNER_HPP */
diff --git a/src/script/squirrel_helper_type.hpp b/src/script/squirrel_helper_type.hpp
index adf88b0e8..946a59547 100644
--- a/src/script/squirrel_helper_type.hpp
+++ b/src/script/squirrel_helper_type.hpp
@@ -12,9 +12,10 @@
#ifndef SQUIRREL_HELPER_TYPE_HPP
#define SQUIRREL_HELPER_TYPE_HPP
+/** Definition of a simple array. */
struct Array {
- int32 size;
- int32 array[];
+ int32 size; ///< The size of the array.
+ int32 array[]; ///< The data of the array.
};
#endif /* SQUIRREL_HELPER_TYPE_HPP */