summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-10-18 23:22:26 +0200
committermadmaxoft <github@xoft.cz>2013-10-18 23:22:26 +0200
commitbe996c16626e6f7c8a7c43595f5c6efaacf668eb (patch)
tree458548dc0680dc4adf53579e8b4ef994f2cdfd16 /MCServer/Plugins
parentAPIDump: Offline prettify is working. (diff)
downloadcuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.tar
cuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.tar.gz
cuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.tar.bz2
cuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.tar.lz
cuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.tar.xz
cuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.tar.zst
cuberite-be996c16626e6f7c8a7c43595f5c6efaacf668eb.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua28
-rw-r--r--MCServer/Plugins/APIDump/main.lua2
2 files changed, 29 insertions, 1 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 544e02049..a57a7a342 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -1003,6 +1003,34 @@ cFile:Delete("/usr/bin/virus.exe");
Constants =
{
},
+ AdditionalInfo =
+ {
+ {
+ Header = "Practical usage",
+ Contents = [[
+ If you want to use cIniFile you need to know a couple of things; what is the key name and what
+ is the value name. Below is a demonstration of what is what.</p>
+<pre class="prettyprint lang-ini">
+; Comment line
+[KeyName1]
+ValueName1=Value1
+ValueName2=Value2
+
+[KeyName2]
+ValueName1=Value3
+</pre></p>
+ <p>
+ cIniFile is very easy to use. For example, you can find out what port the server is supposed to
+ use according to settings.ini by using this little snippet:
+<pre class="prettyprint lang-lua">
+local IniFile = cIniFile("settings.ini");
+if (IniFile:ReadFile()) then
+ ServerPort = IniFile:GetValueI("Server", "Port");
+end
+</pre>
+ ]],
+ },
+ },
},
cInventory =
diff --git a/MCServer/Plugins/APIDump/main.lua b/MCServer/Plugins/APIDump/main.lua
index fe4df751b..285b0c1c3 100644
--- a/MCServer/Plugins/APIDump/main.lua
+++ b/MCServer/Plugins/APIDump/main.lua
@@ -748,7 +748,7 @@ function WriteHtmlClass(a_ClassAPI, a_AllAPI)
end
if (a_ClassAPI.AdditionalInfo ~= nil) then
for i, additional in ipairs(a_ClassAPI.AdditionalInfo) do
- cf:write(" <li><a href=\"#additionalinfo_" .. i .. "\">" .. additional.Header .. "</a></li>\n");
+ cf:write(" <li><a href=\"#additionalinfo_" .. i .. "\">" .. (additional.Header or "<i>(No header)</i>").. "</a></li>\n");
end
end
cf:write(" </ul>\n\n");