flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

APIDump: Added cIniFile additional info.

Browse Source
This commit is contained in:
madmaxoft 2013-10-18 23:22:26 +02:00
parent 1b7a84d494
commit be996c1662
2 changed files with 29 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
MCServer/Plugins/APIDump/APIDesc.lua
View File

@ -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 =

2
MCServer/Plugins/APIDump/main.lua
View File

@ -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");