From 0773992b68d8334752166977b29623c49f53bec6 Mon Sep 17 00:00:00 2001
From: Reuh <email.thomas99@gmail.com>
Date: Sat, 12 Sep 2015 13:35:21 +0200
Subject: [PATCH] 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.
---
 .gitignore                                    |   1 +
 Makefile                                      |   6 +
 README.md                                     |   2 +
 doc/config.ld                                 |  26 +++
 doc/newonly.png                               | Bin 0 -> 10519 bytes
 sdcard/3ds/ctruLua/{ => examples}/example.lua |   0
 source/ctr.c                                  |  80 +++++++--
 source/gfx.c                                  | 153 +++++++++++++++++-
 8 files changed, 253 insertions(+), 15 deletions(-)
 create mode 100644 doc/config.ld
 create mode 100644 doc/newonly.png
 rename sdcard/3ds/ctruLua/{ => examples}/example.lua (100%)

diff --git a/.gitignore b/.gitignore
index 7f471c4..9208658 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
 /build/*
 /ctruLua.*
+/doc/html/*
\ No newline at end of file
diff --git a/Makefile b/Makefile
index e10a175..5451cc2 100644
--- a/Makefile
+++ b/Makefile
@@ -158,6 +158,9 @@ build-all:
 	@echo Building ctruLua...
 	@make build
 
+build-doc:
+	@cd doc/ && ldoc . && cd ..
+
 #---------------------------------------------------------------------------------
 clean:
 	@rm -fr $(BUILD) $(TARGET).3dsx $(OUTPUT).smdh $(TARGET).elf
@@ -186,6 +189,9 @@ clean-all:
 	@echo Cleaning ctruLua...
 	@make clean
 
+clean-doc:
+	@rm -rf doc/html
+
 
 #---------------------------------------------------------------------------------
 else
diff --git a/README.md b/README.md
index 47f45c6..b115761 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,8 @@ Warning: the 'u' in the repo's name is a 'µ', not a 'u'.
 * Clone this repository and run the command `make build-all` to build all the dependencies.
 * If you only made changes to ctrµLua, run `make` to rebuild ctµLua without rebuilding all the dependencies.
 
+To build the documentation, run `make build-doc` (requires [https://github.com/stevedonovan/LDoc](LDoc)).
+
 May not work under Windows.
 
 #### Based on ctrulib by smealum: [https://github.com/smealum/ctrulib](https://github.com/smealum/ctrulib)
diff --git a/doc/config.ld b/doc/config.ld
new file mode 100644
index 0000000..13c1958
--- /dev/null
+++ b/doc/config.ld
@@ -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
diff --git a/doc/newonly.png b/doc/newonly.png
new file mode 100644
index 0000000000000000000000000000000000000000..35ab1694b590bd609a924217c9e7c8e72a264128
GIT binary patch
literal 10519
zcmV+yDd^UTP)<h;3K|Lk000e1NJLTq001%o000jN1^@s6rrVst001HnX+uL$X=7sm
z0BC`&npad*&6oD;oX#1VoSRIObIv(u$w5Msb4GGf5Je?N5haPBfPg3ph=LgrR8SFA
zRKS1{P!#xh=bg3wb1`%G?X$Y->1Wm6wNI^I-5mggQz8N)<6$NMBBK)G9L)@AZtfm5
z%p$-77C-^KK+-QDK1MPsGzI*hvGEi@|I9No|J3@w*Zr?S2xP<u003e4bay~ZT*96n
z-1||J6Jqu>e1Fep4G8fI+|#f2v~=8Fg8(3i|M>p@YT7?K_+PF3kB)P8G}_bV0MLlR
z|3mx#4;>H^7YTr{^WJ)qe|z|^;Emrq1Q|v|1VhF}Q6@ev*gqjIKsGcW;D7YY2jYPv
zFaw4_1~5Rx-ow~aE<kZ_j0bTb82E#Py*U8Lg3!J3f9C#wi3CPU!auW7bWCboXmCgZ
zO;KJ!MVe-^*EY>5Av%gdlSpRx$A=~`G-)9T2{D>-a#5jCj6g<k9D@<>&xnXlmJNuG
zl+&UyBK<-mG-?05aQr`s`v2QHx-88(Bs898VPr&$iHi;j-P>mGZ$xMSBPyN|NK1?g
zWW>?@Xhv}izl6{v2F)lsGBP?Uo@S7c5Ets7m=GErCF2z07soJ&2n}b@lw{>;`=Vl^
z;}Z6gt^ch;llZ66_`Oa8{<})RzeQxD<AUY>d#iXk|5TZHKe@dEauJMRzleb7Kn7j*
zpR@Rf+ka2zKRm_<DJlM!1rZGaKrQU<{tyKKQwG5H@!j1&O}o3>r}uc62VgYnKl#z8
z08n4w^N;_>6KMp1k`KVZ&Hs4*RRCN%1OVr=fW)|@e?6xE+6}+}2~YqHFaQVefB=Yq
zymy<J0Q26hVg+n~9dH6JzzulzZWuoh05l*7gn<YU1!6z~(19e7+G9x;$N~91s+52-
zPyuQ{9cTbepapb*F3<z|d;A#zV_>pJqB*btmcSa=09#-O9QNpR0?uF`a0PC_9e4mQ
z;0=6$FYwzVGXMmFpgl%I_Sg*HV>c2+foKrB$7}o^wMifuq<~bA2GT(W$OPFS2jqf0
zPyh~sL!b~8fnsn390eudI5+`HK^dq3m7oe#gIZ7r>Oli&1gAg~I1QRX3upyxpdEC8
zbD$G+feWA;^nhN_2l~MPxCAbPD_{s*1;bzjjDqW64BQ0cU;^9%cfeh658MZn;31d-
zkH8Fg44!~lFbAH2=U^VZ1PkC5cn#iwx8NOk4_3e`_y9hE&)^IA3ci6K;3wDso8TAN
z0)N0Z*a5o`1i=szLO~b^3*jLGM1sf=1!9J%5G%w6aX_39H^c++K>`pB5`u&wQAiAu
zfas7EBm>Dp@{j_g1SvzRkUFFRX+heME~F0`Kt_-WWD1!>mXH->1KC0LkR#*_?Sot)
zcgO?sf_$L;kRKEPF`!^51PX&9peQIBiiP5#L?{VLfet|FP$rZG<v@8*0dxo|f(}DR
zpc3dfR0@?tl~5H_1JywdP$Sd?oq<}QHs~yL4(f!?L)}m>)CUbfgU}V|Dl`m@LSxWP
zXac$o-G%N$lh7124LydQLUYh_XdYUCUPDXJJ7^hNg+4-`p)b%k=m)e8{erfjzt9d0
zU>HWi7#If=U=mD$sW2<d4s*iXFdr-c3&O&%C@cX>!qTuTtN<&)DzG}N32Vc;umNlY
zo51F<C2S4b!49w!>;k*N9<Vp;3;V%=a1a~{hr^L@3>*h1!pU$doDOHgIdC3)5H5s^
z;iK?zxD>8{tKeF=9&Uu2;AXfLJ`10N&%@pDMYtaxgoog3@F+Y6kHfd&yYK_}Av_H~
zfoI|8@Jo0RegnUSm*EfaC-@8e9bShw;VpO@-bKI&6atIDBS;7)1Pg)<!HM8O@FQpl
zVT2fhj*v#kA`}qH2sMNzLI<ITFhrOj%n?=yTZ99`8R3F(M|dH85&j4UA_NhRh(g37
z5)jFV1BeVnHX;{MfG9*1BT5h_5aoz!L>=NJq6yKAXhU=$x)9xni--ZlWyDp)2x1H|
zj<|!kk9dffMm#~xAzmOB5pNLh5G#m}h&9A_#5&>^;tyg62_sQRERukvAgM?;Bqx#=
zDS#A0iX!PqX`~!d38{+IK<Xg%kw!=}q$Sb@>40=bx*|Q1K1hEg0~vyhKt?0ukx9r@
zWCk)DnU6e#EJl_fOOX}G8e~246!HwR4cUP_kL*GABL|UJkt4_($O+_K<RtPD@(FSd
zIgfmWTtY4*KOonT-;wLc-^gtgKp|0B6ahs+v7p#d+$esO5K0t9N6DZRP|7HElr~Bq
zWrQ+AS)uGujwlzD2g(QKj|xJCq9ReTs6<pMDg%{+%10HVj-ZaC%2Cy*dekXYGpZfc
ziMoKgh`NLtLXDtqpl+e=p&p`UP_w8Ps72HgY8mwr^#%14^$YbE4bVt57EMGmp;^(K
zXkN4+S`<x3%b*p|DrgO~F4_=ninc`CqMgvLXiu~+IshGljzGtt6VR#X40H~<0DTx;
zf-Xf@q3h6%=w@^~x)a@l?nhrn52MG>6X<*Bhv>)XIrKdGHToU;19}bp9leSEg8>*M
z28SVGs2Fw(4@LkZf|0<;U=%Q_7)^{G#t37MvB5ZCTreIOUrYcd1QUsg#Ux?UFj<&<
zOcCZNrW8|!sl%MYv|!F+&SNfOE@7@>u45)JcQFq!k1@|MFEMX0%a~7?Z<uw=7G@WV
z#Nx0dEEUUv<;4nO#jsLXIjk~P1FMTQ!kS}ku#Q+)tQXb~8-xwV#$Xe%2e4V#d~6Z6
z1Y3r!#x`J2W81Ku*dFWvb_hF)9mn3qKEyu8KEp0z-(pv>YuF#yU)XIN0*A$sa8w)z
zjt?h<6URy86mV)dZJYtl6laZdz`5W&aelZUTsSTkmxN2h<=_tDig71!mAE=w6Rs6^
z4%dSlz+J^%$4%hw;~wE=ar3x0xMkdD+;`kB+%_J@WAP+B3!V$lj~Bty@p5=&ye3``
zZ-TeP+v8pEo_Ife5IzDQhfl_5;Pdc>_!4|Mz6RfjZ^3uqyYU0~tN82qTlfd~8T=f6
z0sj{N0sjTRj{ie|2p9s9KqYVz_z5BeNrD_fg`h<+Aea$s2u=idf-fPE5Jre0BoWdH
zxr9PO389=&OE^VnC3F&c34?@T!cD?m!W7{tVV>}YuuAwsSSS1;LPQLaL}Vdy5ots*
zqBK#Fs7}-+nh>ps4n$X?H!+YHMvNgQ5i^K+#3JG`VkNPjc$(Nwyg=+H4iU$Qw~3R)
zC&U-T*Tfa#8gZTYhXj$ZBr=JO#6uD!NsweoDkLqEA<3L%N7_g7BKea-NztSvQaUM*
zR75&Xsw6d#nn@j`9?~V!Fln50k2FnsMp`7jCw(IQAZ?K$GKNehvypkoLS#Bwj;u=7
zAsdq|$qr;UvM)J^96^pJA0X$D3&|zq3UWR947r2cLmng#lgG*T$us2V<k#dC@)z<3
zd7FZy5GYg%7llR<r^r%NDB2VwiY3K?;zseM1W_U>36wNSE~SWaoKj6`q_k4HD1DS6
z${6J?<q>6$vPgMP`Ak`-{AEHg;hCsRTud}3aV9w?RVE!KV<u}RCngUjf2L5T7^W1a
zET)4@B}^4e4NT2U=a?=sU11tyy2CWZG{>~aw9K@|w86B^jAAA-voiBA3o}bHD>7>^
z8!($Q+cUc|`!WYJM=>WcXD}BqA7w6Qu4is$KF55Kd5C$8`7ZM`^E2kx%&W{_nSW6M
z6-%X1Ij90uajGm;m8wfMrP@;WQN5`QY9uw0nnBH{9-)>~>#5DuPHG?ZD)lDyKJ_v6
z1$Bw~k@|!BhXuhxU}0h5VG(ALVo_qzVlig1W^rcmVhLo4U`b#}XUS(d!cxxCz|z9f
z#nR7mjb)tW0n1aC1(x?LYb+ZqyQ~;i3M&UIja7nGo>iUIfYpN4fz^Z6pEZm%o;8g%
zkM#&^Icq&@3u_na0P8U81nWcAS=LvqE3DsGf3rbscs42<51TNXG@CM;4x0&^Et@Nw
zFIxy(3|lH&4%=b2GPXLlX0}eYezsw@3ATr9b8N5JR@uI@ZLuTRiR`TGeC%TEa_nmC
z`s^0$j_e-n0qha%iR_u|2icFYSF<;<cd%b%A7a1B{($`{`y%@a`#1J24g?30gO!7i
zLySX?L!HBb!;-^^!;6E#5yg?rk<C%WQOZ%z(ZX?_;}XXx#~qGoju#wnIX-i2aso~q
zCzX?jQ-o8NQ;k!f(}L5H(~FbA8O52*nZtRQvy8Kzvz7A#=OE`8=RMBHoC}=GoL@P&
zxDZ@KE_N;fE;^SYmll@^mo1kYmmgO+R{~ci*CDPGT(w-yTwPq3xJJ3|a?NnP<a*Eb
zm1~O|!A;_3=caK>aw~D`aGP@5b9-<Ha7S_{bLVg$<}T+x$=$}?!#%`3&OOOJ$Nh%;
z6ZbmzE)R}}g@=zvoJXEVlgF6HmdB09pC^JRktd6%h^LIFfv1h9hi8aqoaZ6WGoB@$
z&peyF5HEq3jaPt|&a1?$!)wOt!0XA&;Emxuz?;uo!duOInzxg8fcHA@J>Dn0i@dA6
zKY4ffuzXZLUOsU?1wJi46Fz%B557RYXuedwJiZdXYQEEaU3{1LuJhgJd&>8k?<3zj
zKj6pnv+)b?OY$r8>+)OhJMsJQhw#VqXYd#Dm+?37xAXV%U*o^UKg~bSzs&!g|E~Z>
zfGWT%ATFRNpe<k~;3(iF5G)WUkS=gYpj4nipiQ7x;F`c~foXx40xJSP1a@dx8Vik|
zMyDy$^k|keXPPf9jFw2trWMmFX-%|F+9lc;?E!6$wnST_{T4(DQUtjLMFr&rwFFHC
z9R$4ug9YORGX;wT%LN++I|Ta$M+NT-&I-N}{4DrO2q{Dn;uaDWk{8kzG81wX@(~IZ
zN)XBtDi*2~Y7*)a8Wg%A^ib%z(0ie8LVty^!Ysl9!ji%&!Un?D!fwI=!qLJ9gbxaz
z5N;4|7w!`t5xyt<RQQeXn(%KCln9duuZV<*l8By&m57Uozetowsz`yz36Xk{c9A}j
z5s`Z$vm#3(Ya&~sXi=&tzbIW)MbtplM$}!DAsQo^E?OvBE_zC|Q*==Drs$ODyy&v%
z57AvQf*6OGu$Y{fmYA8ClbEkqxLC4SzSwcGda-t~KCw};`(krqZ^gcfZHwc?*~A6K
zWyCeaO~oC>eZ<4Wlf?7HkBQfbw~6<OkBZ+He<uD;{G0f;1YUw&LRdmhLQBG2!dYU!
zM5IKj#6gKtiIWoNBrZwZl$eruDX}WCL5JxSIuBifu1q(e+t5Ae!Sr}~HvI^_hTcl=
zrH|0>)92{#=-=o&k_1UkNfAi}NnJ@xNmt20$ymt@$-|OWlFgDmlGh~fO3q5YmHZ~T
zBZZgZkP?wnkkXa1l5&$`NX1EINga`@k!q3Zl^T({FZE37z0?nBNSZ9oBP}7VB5f#b
zC+#I2DxD;qCw*M{r1UxILFsYnY3W7j&(d2m7#UU>K^Zw2Z5az07nwkrSeZ<jVwoD5
zR+)=3*JUPUUdXJ<Y{(*InPvH9rDZi_&19Wr{bZwM(`66KR>`)=_R5aRK9GGOyCS<G
zhmd2I<Cl|`)08ul+b8EQ7bBM`S1eZ}*Cy8|HzqeF_fqbo+;4fbJgdBryqvs_yp_DW
ze6W0ie6IX)`IGXU@|Wdr$v=@_lK&>Zt3XoVR*+CoRWMd?RM@W&rI4<0SfN^>RiRH|
zOkql4LE)3amLgV>T~S0)QBhyfR?$l_OfgmQkYa`68O0vO5yc0J^NJr7e<`7rSe1m8
z6qNLoY?Qo|!jw{!4k}eBol)vh8daK9npgU$^jjID%&sh=tfXw9Y^Us_9HE@1T%=sB
z+^XEKd_#F!`IYh)<!u$B3bzVfMNP$2#aSglB~B$<<(Nu?N~g+@${m$Cm1UK6RirA5
zs-UX8s-CK?s+VfG>H*av)hg9i)qd5RsxzvuRlln4s*%<B)TGt4)GXB8)PmKL)C$zf
z)y}B(s$Ex`Qd?A8Q`=T2s`IEzs%xm5tGlWPsVA!EtCy*tR_{^2u0Ex{sJ^DYtwGe_
z(U8*6)UeQS(+Ji`);Oq9q0y|-r*T7LTI03GH%*{P(G<{>)zs0n(e%;`*G$tqtXZph
zR&!AEw&twnvgU>sT8m9fR7+XQSj$N(Kr2owSL=jUlUBFZsMeI$qShC!9c{8UzqX9F
zj<$`qmv)49x^}U4o%T8HE82IppKE{6{;h-4;nJb&Xy};hxaoxGr05jtRO__qT++Fv
zGpn<#v#E>G<<J$^Rns-ob=3{lP1Zf6Tcz8kdr9|}?yT;z?xr3_k3&yfPfgEE&s8s2
zFGa6VuUfBNZ&2^H-ZQ;bz2EvceJ*`TeNBB!eGmO`{WSez{d)aQ{j2&9^k3?K*55H8
z8}J**8R!|<8SFQRF~~7EVQ|`@*WiZ1jKN!jpN1$yHbXH(RYNmFSHlp)6vHCJTEh;*
zA;Wuy^M;=dw~fd~0!DI1`bG{$enxRdc}C?%%|`u36GpQ}%SOM9amL)nQpQ@w*2dn(
zQN~%u$BmnedyU78XN=z(ubZGvI7}o=G)yc_JWV1@GE7QL8cn)QuA5AoESdZ?MVWG#
zN|<VxTAF&AMwn)p9y2{<+G9FqI%E3Qbi)i|#%V@3(=xL*^EQhz%Qib<cG|4ZY~1Xr
z*^1e3bG$jPxs17<xxKlcdAxbPd8K)q`DOFF=JV#C&37%BEQBnSEKDq1EJ7>}SQJ|{
zSe&;QwV1Y8vRJo7TXI@TT54I^So&JVTIO1oTeezWvb<yY!t%4_t`(D&kd?BPsg;{m
zs8yQPQL9F)9;+KxPpp=$ep}<Md97uw^{pMP1Fe&+3$1IdJFSPUr>x&t|Fl8daM?)N
z=-AlV_}RqU6xdYRoVB@XGime6=DRJ@mcy2At7U6r>uVcln{Qibd)9Wy_JQr9?RPt*
z9lIUfPRq{LZogfeU4dPdU5DLOyGgs(c0cUV_MG-o_B!_V_Wt&X_J{0i?Yrzp?5FMD
z+HX4G9C#h%91I+s9fBQF9ga9OI`lZ)beMHmb@=N@aTIb?b~JPJaEx@!b}V&laU68K
z=eXeb%?atm?nHOecCvHwcS>|BbgFYY?{wYivD32CmNUtj=B(sw>g?_u;hg1M>fGWy
z=zPz4!TI|>)IQFAQu}oGIqYNXOW9Yv@8rIoedGJ)_I=#9<3e>2by0V*a`APEb187C
zap`m!ahY*>@3Q4ea;3Q{yPCOrx<<L?x>mTJb-n63<+|j$>4taXcT;dPadUHvaLaZp
zb8B<E;x_5_#%<jl=g#LY?{4hw<{s{z<zD9A=6=O}(*2G5h6m1r&qKk(#KYYq!Xw+G
z+@sy&s>hVaTaRC!1Wy4^B~LR?PtR!2JkKi6bDkrfGoH(yf4nGO!d_}#R$lwP61)n%
z>b<(XZhFmmee#C9*}UoAI^GW64DSQpCElmK2fXijFM9v*!TRv}$om-kxcfx<<oZ<l
zboh+;%=j$({Pkt>74_Bdwe|J)P4+GJJ>}cyd&l>s@Av)a{XF~S_8aea+aI|<cYo#n
zbNfg3Ki<E(f7_4hC+?@^XYa@GJK$I1cgAnf?}6WIzYTwaKh0mo-@@O=Ki<F4zrnxP
z|Cav?|E~e40PX;}0OJ7nfT)1Hfa-v*fU$ttfKP!?AbX%xpnl-Kz_7rqz>2_*z>&bm
zfvbT#3>F5Rq04Y$gfKD~WsG*lHO4e!g|Qt(4H6I1333by4$25B4QdOz7Bn5S60{vm
z4VDPj33dt&3C;{I3qBh>9Q-(VHF!6KHAFH*FJxaxSV(qAWyraZ>mg4=K83=e9HBCy
zMxkz@QK9*vHK7+m$3tI)ehov1@rEgenTL6Y#fKGzHHP(v-3@ycwh>MY7YbJow+#;r
zKM;OAyfyr4_;mP6_)Y|Cgk*$%giAz3L~cZN#QBJu5ziyOMxrBmBb6d8B7GwhBa0)O
zA_pTUBi}}DMKMQ-N9ja4MTJFWM^#33Mcs&c7WFk69nBl96m1c`KRPM;Nc5TL%h6NO
z@1wV4SYjk&^kZCOB4hGnYGZn0ZpAFb{EQ{U3dO3&+QkONrpK1WcEpax&c?3AA>(-B
z6ywa}eB+Yhj>a{|U5R@Xw-UD-&mJ!wZxrtl9~)m7-xxm-{~-Qt{8j>Uf<%H|f=fbV
zLViMBLT|#IgjWfhiR47FM4d$E#PG!2#G1tJ#9N6Ai5p3zB#|VoB*&z%q@1Mcqzg&6
zk`|KIlZnY9$y&*d$zjPk$<@i-$+wahk~dOFDWWObDb6Y3DY+@NDLpB7QeLI}N~NTV
zr|PD<q(-F{q&B4XrQT0nO8s+y<$&Y?!vh`%Vh<D@XgV->VCuk18c5?vlS?y8^G!=i
zD@kij8%}$gww8`c=Sx>fw@GKDXQWr8ccqV~&!_*)AZCbUXlFQQL}cV=)MxZ%Jji&L
zv7O15DU)fE>7ALFc{H;nb2#&9=2{jyi$6;(%PuQ8D=Vuit2^s<)~l@F+05DWY=dl%
z?6~a1*=MqcvL9!E%0cGv<*4M?<^<(r<y7T#=iJVDo%1`Fnk$)Wl<S$Bkb5MzC3iUY
zY3`RiOdc&yBhMi(EH5vwF0U`|LEgK(oqUdb`F!(yzx)IFW%-@?H}hZSZxm1pBnk`)
zJPP6piVK<xt`$5j_;L_?Q1GDUL8pTe2MZ3KJb3Bg)WOw5@FAW<%7<(Y1s}>jRCB2J
z(7i)%4{aB66v`J`6#5sY6;>3UFT7Rws&K1_rAWHSw8*z8rRYS_xuTmz3q_lUnGQ=H
zHahHmIO*`Q!)FhV9iBhDUQ8*LC^jtiEKV#gDQ+(wD}GVDeuR8P;)vl9&m)OPjvZ+~
zGInJC$of&rQTkECqh3dojvhaH_UMhHFOP1PFqcS`7?=2zq?DAFbe2q%yeio`#&S&N
znAtJEV`;}Kj$Jr*=h)J*?c*HB6^>gSXB^KuUVFUn_~h}G6YvS%6RIcdPlTT+IMI0G
z@`;%fYo*vyp;GNq*V5S1;?maA(bDIoKg%d(^fKczpR$y)va+tS+huRc{+4r;E0kN8
z2bJfP*Od>HPnCbHKvmExv?}&h#8e!vXsH;jcwVtyNvV{qG^zBhJWyFt*<E?J@?90E
z;;B-pvabrSI#|_IHB|Mq>RUCjTD;n@+PgZry0p5h`gZkF^-c{}jdG1$O;}Aq&8eE9
znx{42YKgVtwT87mwW+n`wHIpd*1oF)b-Z<Ib&hqBb%k}!bt84p>(=X;>!s_>>I3RC
z>uc)!>!<2JHeecr8gv@m8xk6hH=JvjXn51GeUj^>@=5!X;U^EBJbiNb<nxp3jm(YG
zjpmI3jaiL#jRTF-jcccHr$kQ~obo!Aa;p4P_o;iQmYWbw0!^AtE=_SwB~2Yo6HTw1
zwoh}NRypl(I`VYU>6X*iPrp3<`wZI|g)=s1LeCVOX*zT5%(FA=&CJa*%@)m!=A7n}
z%~zVAHh*s+w@9{_wFI<ewbZo?wmfe6+DdGtx0<y2wPv=~whpw;w0>zLv`MrXx9xAs
zXsc-(Xq#^P(oSfXXg6;6YtLw}Z69c#Y5#JTc$R+F<gEYM%(Hc82hTn}`>liAA=zQp
z5!jL4(a>?FW47bRIi_<m=Pb_!pUXRU>fE(+&(CdkvUbXM+H{6>9_noFyxzIc`KODs
zOQp-PE4u4Q*V(R#uBG$fJl}cE^RDL;&X=CQaQ^=J)eGng!WZ-}_*_W4P<^5Q!pw!Q
z-K1{GZu4$NcW!rM_qFcl-J3mZJ&HZ{J&`?!d)j-(dzN}ZFMqFAuX}G&Z+UM|@5A0t
z7x5RxFPdERznFdT<i(+j&n|BCvGytU+4V*C75BCGP4vC(hx-Nkb^1N~Q~N9X`}(K*
zzYdTGqz5bpf(Hr)&J0{1SRB~C#B)jGlIx|!OJ$dOE<L>Td5|zjA2b_e4CW0s4UP=H
z9Q<>c>$3V~m&*y4OD}g{p1l0|3gHU<irJN*EBRMWUm3l!cx8KtXGn9%Z76A|V(8+~
zqoJ=?$ya5rT3rphT6nef>iE^AYw$JNHN9)z*V3=mUAug3?%KvM+pyBG<8bWovElQ>
z4~9RE;78~qW+Oo(1tZNPV<WFe!KlEf?x@#j+Gy?Q<<Ys(&FgH}m9INpkGp>2diV8*
z*Vo2KW71<*V_{=OW9?(N#@^pR-4MB9bi@Bf&W%$yMsF<M*tyAfQ~Rdp&9s}fH!t6u
zySX{eF|InkZ#;3leEj10^!WD)<_Y-;`-$j@V-x2m9!z|`MZ6__%j#D6t;4rEZr!=H
zdK-IN;<nlC;M)gpx85GV{q7Fxj>sM3JArrd?wq-E<IbDA@Li$126z4L=G<+%J9_uk
zJ#de9Pye3py{vnU_eSn5-rKz|a9{7f&;88%C+`p6U%0>Xfd7H+1D^+(4^BQ9ez5Rh
zXHsBNZ_;-%YqD{2WO8wG_aW_}{=@wbvmc&%c>Uq)DQHS?%5chmDtGGi)Qzd7M~Fuv
zkBlEN9u+)lc{K6p{WNA;eA;X}WV&$r?DU=K4>R}~sTu2;h?%1^T{Dw2YmX_9<saKW
zj(uGExcBkQ<DXAhpQt=>d6N93>dD}fXHT}CazE92>h(0^>B*-fPZwvwtl+HSY`|>(
zY|HG#?D8CTjy`8O7e04nu4`^`?#nZ#X9~|8pT$2bf7bu(>9b$Yxt?o2_k5oI{N(eI
z=dWHsFN9tgzhJyL_@e#AofjYG3G*`Zw)4^RC+2(SAJ4D9WPhpt(*0%H%lenYFBcb}
z1)&Aw1;)amh4zKJ3!fHAi*k$hi*bwPi~WnUi@#rSztVo?^D66A)2kb=-n~Y@mUwOX
zI^y-w*B4$tdi~=K+Z(kv?r#pfsed#4=G79sB(h|>6tZ-9sdH&^>FZnSTjjSdZ&TjZ
zzP<W(;T`l&_?^kS;CDsu&b@o^?(2K%d*$~o?^EB`y}$N;aT#6~SvFk`T`pekTAo_|
zzQVeqw&K2$wsLZ1bY*E3wJNb{xf;28Y_)gw@#^LWt`FKDd_LrSX#OzqVf7>7qwGhA
zkMSQXKVJSg|8eJ&;3wlxL7$2~b$)vI>HBBa&uX7NK4*MB_4&r<cWc-+sWscR*tPPt
zOKZ>9w!hH67<~!)QuL+s%fm0<zp{N*|LXZQ^J~-B@vkf22;XGCIebg_R{d@0+roF~
zyU2I*@8RD|zW028^8MEjo*#NY{C^buIQ!%NkFP&jeyaZT_?hvu>F3R#E9-=Hxpl|&
zr1hHhYwNEzkQ?F~RvXb9r5ghq&o;I<1via1LpG0Wc5lvXZvNu=rTfeO*TG*Mzb1cu
z`_1-S<G1(koZl_K@BIF>#k8fo<+hc+b!zM8*2*8^ANfDde^UO`{~7)B_AmCY^k4hG
ziGOSUUi<rc8?{Z}w%Lx`uH3$|y|4rCi0@eKMDLXE4DQVDf?d&Fi`~fG(%pgG7rVRv
zepj*=h<}DNvj8}!17Q6CfSOtW#DW2!c>O<Kn4M^pUNm?B000SaNLh0L01FZT01FZU
z(%pXi000KANkl<ZNXM;KNo-YR6#niT`yL&kv`o=5#l&=CK>}qavY`qI8x|PLh6OWW
zh>$?EVB8rIBMWRHmLaAK)CxqxBvNQvK&BKamX=aGQA<mQH{9uX&JXwc9^lTCcXRJO
z|9Ss^hVOjmYPM|?3*xZhF>JsWfK3Jh8bQ-M>H;*rYj8yD<r1A-uf97r|CgwpY=R-4
z*zBif!X%CF8oVA27W?N>2l6jyvjdyU;W_#}44)sC^2dJT#^S8U<5AC?2v?UFtn>b=
z{=e2<)g>lI90n&=P7HXxcoZ4IM?Y8Lc3(HV?7NqJ_Ytup92Nao15d?Qu)g&obgL2O
zCtKmmN{9IA^=jzo=s;av9iBaVhOuMEV!?t17(IHlTMfq<k*205)YsP|5{Y2Slqr}s
zYZlVe(_P#4_I7l3b}HL~f&zrYVYIciDP2lR3Z_q=j!~mV;ql|g=;`SZJRrZg0DeYG
zb?bfXu04%E`#PZWamSXHA;r&58rBdQwnfjs*iW(aT+)$B!zsBm{Gf#lJ~eKdw15A8
znmBPHy{xjjrcRwoCr_RfSdz&$mSs_2UmtDQuz}cV*N!Vk#l^*R_Uu_@D|TDAZlz!_
zNSp}b<S6~7O`9kX2vBBbCSAOEQR&vKS)=Ua?8XNVC}tS6?1v+S&$dv?mmkxj69=ia
ze}MfTCYV-~3?oK{K0>j^`=oC#r|8$;(1>M|^iNggk)!}Zp^*EWnwm<dPMvatS+#1F
zyOx!eMUy5?a^EvDGN_@ULD_EKzFq0K5_Ij_wIrSFSzBAHbY*2_O2-JGrlvp0CX;UW
z{zYYHs_4w4`!uA-`P^YL;s!U6p_66CC~g}hZEx~5!hu=5I5;#!c~d5<%_MsV4jiCc
zw{Fqiy?covp!9R*%%NB;M%C5TuG8z*ts{nts!&Z$jT=yDX{ic$+qP}4(@r2ecI;5P
zw6rw3diAQ(tzNxa>Bf&APfZV-$>ii(I{Rs<Wit34wc->pb@FkW;7)HPdY{)KGn|jn
z;puoQ<2`u%0o=QB7u}s*3d`%)ugAuX8`U#IMdA1G;lsFd=Z?ZQSH{Ks?%li5)zt+K
z1k<KX!_uWoap=$?T)%!D4<9~+-|v4Tfh4kG67xyp!(<x^7WcC~co*pU6&}46wr;{(
zxDP%Lw|(352HflZ4k^6XxKIJc7cD@5L*(qatW;D~r0$GyZhkKqx9-8B6EYB)F=GZ=
zT3Rr7?p(!e4g-liefktno;-oi=Tq;_dLsLY&SAtv`hBqlx4rzQ?FV@4KLw@mv<Oas
zR<w)D!F(LD!^jTiA{fj<Zh8rmm{0vXk!Be_Ntx4iJ&B5)zy<~e!2N)dk`mWpxl6E2
z5STf0CeEEZ=Q_;|uAaH6-Tj>ZNy3~&8J5Yjf@g+Ii_ARGgm+;X5!j(j1Whk|Hjlzt
zlQ*M;wjkioLQvzf+y9o{$<(Wom^C?g-n@CJs;UCB6BygzhE+}pUHA9*D`%uKLfMX^
z(P$Knjg839&sUT!B9z_Q+KR%$LUea`zu2DxN=wh+oLfBExGHb2f<5sAFl6A@yI=-0
z<T=ii$ZakY-ZH77bA*2H7*@^n+m$Pd{-m<Uj~{pGQ)K7Poo>T6H#bvnZ?B?c(FujF
zUAva{?Ab%JXU|r2%yWTu?b@aOfBN)k;vkjnm@#8${`~pG*>}kzCntw^PPsZ+*W+=D
zv448+AjK{>kv^i+i1?#hq;tc=G?>CHgKAm^=);;p3LSh(vrlx;VBDgM=g+yDS5{WK
zG%Lc5@2+uHmF~iY3p8%rxFouEuI0;@6IVwC!tkRND^|Q_vuxS2B+7P@a_Q0~l3Yg&
zlOmu0La{M>NH49RcttJg{SjtdlUYlB26#}{ZsS-Jf6WAah%@F4?t#3#Jd~H0tA3DD
zJCj+iB}<m5UJwS#&dyf4#ful?^5x4odi1DbD6WzsiA9SRVdct|3iAS0rdU)|RDi36
z^XJbin2L?C;?0{k6+{Jc!gvDHg$ozL<{t4znYlWKVTHoLjc%B|{qUC-KuhIbvP^?a
zCg#7RQ7Sy#L+_vIqpl$yGCV~U<Pt=5QW2*rj>x;S<_HH*Lp+BPZ4&Jqh{_BS+eFxk
zaIYlq&uco*kO<qykKCZ>JNrog=^p7k`QqFjn#H(N&CB0h%{=LI!WKro%$%?nk)}Q#
zUwj3>&izh>B&$N#4t*xBB~oh=t@2tTGs(JR>oA@2L-g`ZsJ-;X<AdEk0OW?@_470P
Z_zz5W6m=ONgKz)<002ovPDHLkV1j3*i*Nt{

literal 0
HcmV?d00001

diff --git a/sdcard/3ds/ctruLua/example.lua b/sdcard/3ds/ctruLua/examples/example.lua
similarity index 100%
rename from sdcard/3ds/ctruLua/example.lua
rename to sdcard/3ds/ctruLua/examples/example.lua
diff --git a/source/ctr.c b/source/ctr.c
index 0fe153e..37e2c19 100644
--- a/source/ctr.c
+++ b/source/ctr.c
@@ -1,3 +1,8 @@
+/***
+The `ctr` module.
+@module ctr
+@usage local ctr = require("ctr")
+*/
 #include <3ds/types.h>
 #include <3ds/services/apt.h>
 #include <3ds/os.h>
@@ -5,27 +10,84 @@
 #include <lua.h>
 #include <lauxlib.h>
 
+/***
+The `ctr.gfx` module.
+@table gfx
+@see ctr.gfx
+*/
 void load_gfx_lib(lua_State *L);
-void load_news_lib(lua_State *L);
-void load_ptm_lib(lua_State *L);
-void load_hid_lib(lua_State *L);
-void load_ir_lib(lua_State *L);
-void load_fs_lib(lua_State *L);
-void load_httpc_lib(lua_State *L);
-void load_qtm_lib(lua_State *L);
-//void load_cam_lib(lua_State *L);
-
 void unload_gfx_lib(lua_State *L);
+
+/***
+The `ctr.news` module.
+@table news
+@see ctr.news
+*/
+void load_news_lib(lua_State *L);
+
+/***
+The `ctr.ptm` module.
+@table ptm
+@see ctr.ptm
+*/
+void load_ptm_lib(lua_State *L);
+
+/***
+The `ctr.hid` module.
+@table hid
+@see ctr.hid
+*/
+void load_hid_lib(lua_State *L);
 void unload_hid_lib(lua_State *L);
+
+/***
+The `ctr.ir` module.
+@table ir
+@see ctr.ir
+*/
+void load_ir_lib(lua_State *L);
+
+/***
+The `ctr.fs` module.
+@table fs
+@see ctr.fs
+*/
+void load_fs_lib(lua_State *L);
 void unload_fs_lib(lua_State *L);
+
+/***
+The `ctr.httpc` module.
+@table httpc
+@see ctr.httpc
+*/
+void load_httpc_lib(lua_State *L);
 void unload_httpc_lib(lua_State *L);
 
+/***
+The `ctr.qtm` module.
+@table qtm
+@see ctr.qtm
+*/
+void load_qtm_lib(lua_State *L);
+
+//void load_cam_lib(lua_State *L);
+
+/***
+Return whether or not the program should continue.
+@function run
+@treturn boolean `false` if the program should exist or `true` if it can continue
+*/
 static int ctr_run(lua_State *L) {
 	lua_pushboolean(L, aptMainLoop());
 
 	return 1;
 }
 
+/***
+Return the number of milliseconds since 1st Jan 1900 00:00.
+@function time
+@treturn number milliseconds
+*/
 static int ctr_time(lua_State *L) {
 	lua_pushinteger(L, osGetTime());
 
diff --git a/source/gfx.c b/source/gfx.c
index 4dc4248..f070648 100644
--- a/source/gfx.c
+++ b/source/gfx.c
@@ -1,3 +1,8 @@
+/***
+The `gfx` module.
+@module ctr.gfx
+@usage local gfx = require("ctr.gfx")
+*/
 #include <stdlib.h>
 
 #include <sf2d.h>
@@ -12,15 +17,43 @@
 
 bool isGfxInitialised = false;
 
+/***
+The `ctr.gfx.color` module.
+@table color
+@see ctr.gfx.color
+*/
 void load_color_lib(lua_State *L);
-void load_font_lib(lua_State *L);
-void load_texture_lib(lua_State *L);
-void load_map_lib(lua_State *L);
-
-void unload_font_lib(lua_State *L);
-
 u32 color_default;
 
+/***
+The `ctr.gfx.font` module.
+@table font
+@see ctr.gfx.font
+*/
+void load_font_lib(lua_State *L);
+void unload_font_lib(lua_State *L);
+
+/***
+The `ctr.gfx.texture` module.
+@table texture
+@see ctr.gfx.texture
+*/
+void load_texture_lib(lua_State *L);
+
+/***
+The `ctr.gfx.map` module.
+@table map
+@see ctr.gfx.map
+*/
+void load_map_lib(lua_State *L);
+
+/***
+Start drawing to a screen.
+Must be called before any draw operation.
+@function startFrame
+@tparam number screen the screen to draw to (`GFX_TOP` or `GFX_BOTTOM`)
+@tparam[opt=GFX_LEFT] number eye the eye to draw to (`GFX_LEFT` or `GFX_RIGHT`)
+*/
 static int gfx_startFrame(lua_State *L) {
 	u8 screen = luaL_checkinteger(L, 1);
 	u8 eye = luaL_optinteger(L, 2, GFX_LEFT);
@@ -30,18 +63,32 @@ static int gfx_startFrame(lua_State *L) {
 	return 0;
 }
 
+/***
+End drawing to a screen.
+Must be called after your draw operations.
+@function endFrame
+*/
 static int gfx_endFrame(lua_State *L) {
 	sf2d_end_frame();
 
 	return 0;
 }
 
+/***
+Display any drawn pixel.
+@function render
+*/
 static int gfx_render(lua_State *L) {
 	sf2d_swapbuffers();
 
 	return 0;
 }
 
+/***
+Get the current number of frame per second.
+@function getFPS
+@treturn number number of frame per seconds
+*/
 static int gfx_getFPS(lua_State *L) {
 	float fps = sf2d_get_fps();
 
@@ -50,6 +97,11 @@ static int gfx_getFPS(lua_State *L) {
 	return 1;
 }
 
+/***
+Enable or disable the stereoscopic 3D on the top screen.
+@function set3D
+@tparam boolean enable true to enable, false to disable
+*/
 static int gfx_set3D(lua_State *L) {
 	bool enable = lua_toboolean(L, 1);
 	
@@ -58,12 +110,26 @@ static int gfx_set3D(lua_State *L) {
 	return 0;
 }
 
+/***
+Get free VRAM space.
+@function vramSpaceFree
+@treturn integer free VRAM in bytes
+*/
 static int gfx_vramSpaceFree(lua_State *L) {
   lua_pushinteger(L, vramSpaceFree());
   
   return 1;
 }
 
+/***
+Draw a line on the current screen.
+@function line
+@tparam integer x1 line's starting point horizontal coordinate, in pixels
+@tparam integer y1 line's starting point vertical coordinate, in pixels
+@tparam integer x2 line's endpoint horizontal coordinate, in pixels
+@tparam integer y2 line's endpoint vertical coordinate, in pixels
+@tparam[opt=default color] integer color drawing color
+*/
 static int gfx_line(lua_State *L) {
 	int x1 = luaL_checkinteger(L, 1);
 	int y1 = luaL_checkinteger(L, 2);
@@ -77,6 +143,13 @@ static int gfx_line(lua_State *L) {
 	return 0;
 }
 
+/***
+Draw a point, a single pixel, on the current screen.
+@function point
+@tparam integer x point horizontal coordinate, in pixels
+@tparam integer y point vertical coordinate, in pixels
+@tparam[opt=default color] integer color drawing color
+*/
 static int gfx_point(lua_State *L) {
 	int x = luaL_checkinteger(L, 1);
 	int y = luaL_checkinteger(L, 2);
@@ -88,6 +161,16 @@ static int gfx_point(lua_State *L) {
 	return 0;
 }
 
+/***
+Draw a rectangle on the current screen.
+@function rectangle
+@tparam integer x rectangle origin horizontal coordinate, in pixels
+@tparam integer y rectangle origin vertical coordinate, in pixels
+@tparam integer width rectangle width, in pixels
+@tparam integer height rectangle height, in pixels
+@tparam[opt=0] number angle rectangle rotation, in radians
+@tparam[opt=default color] integer color drawing color
+*/
 static int gfx_rectangle(lua_State *L) {
 	int x = luaL_checkinteger(L, 1);
 	int y = luaL_checkinteger(L, 2);
@@ -105,6 +188,14 @@ static int gfx_rectangle(lua_State *L) {
 	return 0;
 }
 
+/***
+Draw a circle on the current screen.
+@function circle
+@tparam integer x circle center horizontal coordinate, in pixels
+@tparam integer y circle center vertical coordinate, in pixels
+@tparam integer radius circle radius, in pixels
+@tparam[opt=default color] integer color drawing color
+*/
 static int gfx_circle(lua_State *L) {
 	int x = luaL_checkinteger(L, 1);
 	int y = luaL_checkinteger(L, 2);
@@ -117,6 +208,16 @@ static int gfx_circle(lua_State *L) {
 	return 0;
 }
 
+/***
+Draw a text on the current screen.
+@function text
+@tparam integer x text drawing origin horizontal coordinate, in pixels
+@tparam integer y text drawing origin vertical coordinate, in pixels
+@tparam string text the text to draw
+@tparam[opt=9] integer size drawing size, in pixels
+@tparam[opt=default color] integer color drawing color
+@tparam[opt=default font] font font to use
+*/
 static int gfx_text(lua_State *L) {
 	int x = luaL_checkinteger(L, 1);
 	int y = luaL_checkinteger(L, 2);
@@ -161,13 +262,53 @@ static const struct luaL_Reg gfx_lib[] = {
 
 // Constants
 struct { char *name; int value; } gfx_constants[] = {
+	/***
+	Constant used to select the top screen.
+	It is equal to `0`.
+	@field GFX_TOP
+	*/
 	{ "GFX_TOP",       GFX_TOP    },
+	/***
+	Constant used to select the bottom screen.
+	It is equal to `1`.
+	@field GFX_BOTTOM
+	*/
 	{ "GFX_BOTTOM",    GFX_BOTTOM },
+	/***
+	Constant used to select the left eye.
+	It is equal to `0`.
+	@field GFX_LEFT
+	*/
 	{ "GFX_LEFT",      GFX_LEFT   },
+	/***
+	Constant used to select the right eye.
+	It is equal to `1`.
+	@field GFX_RIGHT
+	*/
 	{ "GFX_RIGHT",     GFX_RIGHT  },
+	/***
+	The top screen height, in pixels.
+	It is equal to `240`.
+	@field TOP_HEIGHT
+	*/
 	{ "TOP_HEIGHT",    240        },
+	/***
+	The top screen width, in pixels.
+	It is equal to `400`.
+	@field TOP_WIDTH
+	*/
 	{ "TOP_WIDTH",     400        },
+	/***
+	The bottom screen height, in pixels.
+	It is equal to `240`.
+	@field BOTTOM_HEIGHT
+	*/
 	{ "BOTTOM_HEIGHT", 240        },
+	/***
+	The bottom screen width, in pixels.
+	It is equal to `320`.
+	@field BOTTOM_WIDTH
+	*/
 	{ "BOTTOM_WIDTH",  320        },
 	{ NULL, 0 }
 };