added textual type/field descriptions and wiki mode

[l2e.git] / src / loader / Interpreter.cpp

diff --git a/src/loader/Interpreter.cpp b/src/loader/Interpreter.cpp
index 0c17bd56af986ea20ceb83ecab1cd43ca1db9f17..a3d382ceba7618f9f1782bf718c1cf49293753be 100644 (file)
--- a/src/loader/Interpreter.cpp
+++ b/src/loader/Interpreter.cpp
@@ -350,32 +350,42 @@ void Interpreter::Postpone(int type, int id, std::ptrdiff_t offset, const std::s
 void Interpreter::CreateTypeDescriptions() {
        {
                TypeDescription &td(TypeDescription::CreateOrGet("Boolean"));
+               td.SetDescription("Logical value which can be either true or false.");
                td.SetSize(sizeof(bool));
        }
        {
                TypeDescription &td(TypeDescription::CreateOrGet("Color"));
+               td.SetDescription(
+                               "A color in RGB format with an optional alpha channel.\n"
+                               "Components range from 0 to 255.\n"
+                               "Alpha defaults to 255 if omitted.");
                td.SetSize(sizeof(Color));
        }
        {
                TypeDescription &td(TypeDescription::CreateOrGet("Image"));
+               td.SetDescription("Path to a PNG file with image data.");
                td.SetSize(sizeof(SDL_Surface));
        }
        {
                TypeDescription &td(TypeDescription::CreateOrGet("Number"));
+               td.SetDescription("A signed integer.");
                td.SetSize(sizeof(int));
        }
        {
                int stringId(TypeDescription::GetTypeId("String"));
                TypeDescription &td(TypeDescription::CreateOrGet("Path"));
+               td.SetDescription("A path in the filesystem which is interpreted relative to the source file's location.");
                td.SetSize(1);
                td.AddSupertype(stringId, 0);
        }
        {
                TypeDescription &td(TypeDescription::CreateOrGet("String"));
+               td.SetDescription("Some characters.");
                td.SetSize(1);
        }
        {
                TypeDescription &td(TypeDescription::CreateOrGet("Vector"));
+               td.SetDescription("A pair of numbers usually describing a 2D translation or offset.");
                td.SetSize(sizeof(Vector<int>));
        }
 }