1
0
Fork 0
mirror of https://github.com/ctruLua/ctruLua.git synced 2025-10-27 16:39:29 +00:00

Fully documented ctr and ctr.gfx in the C source

The documentation can be built using LDoc : run make build-doc

However, there's still a bunch of things to document.
This commit is contained in:
Reuh 2015-09-12 13:35:21 +02:00
parent 9d8c499afc
commit 0773992b68
8 changed files with 253 additions and 15 deletions

26
doc/config.ld Normal file
View file

@ -0,0 +1,26 @@
-- General options
title = "ctrµLua documentation"
project = "ctrµLua"
description = "ctrµLua: Lua homebrewing for 3DS"
not_luadoc = true
-- Generation options
dir = "./html/"
style = "!fixed"
format = "markdown"
plain = true
-- Input files
topics = "../README.md"
file = "../source/"
examples = "../sdcard/3ds/ctruLua/examples/"
manual_url = "file://../libs/lua-5.3.1/doc/manual.html"
-- Custom tags
custom_tags = { { "newonly", hidden = true } }
custom_display_name_handler = function(item, default_handler)
if item.tags.newonly then
return default_handler(item).." <sup><img src=../../newonly.png alt='(N3DS only)'></sup>"
end
return default_handler(item)
end

BIN
doc/newonly.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB