vmario/doodle3d-firmware
0
0
Fork 0
mirror of https://github.com/Doodle3D/doodle3d-firmware.git synced 2026-04-14 12:31:24 +02:00
Code Issues Releases Wiki Activity

Add doxify.sh to generate HTML code documentation using ldoc; update documentation in several utility files.

Browse Source
This commit is contained in:
Wouter R
2013-07-28 05:01:58 +02:00
parent 827affd4e4
commit 07ca14e35c
8 changed files with 150 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md Normal file
View File

@@ -0,0 +1,12 @@
WiFi box OpenWRT firmware package
=================================
General documentation can be found on the wiki: <http://doodle3d.com/wiki>. Source code documentation can be generated, see below.
Documentation
-------------
The script 'doxify.sh' generates HTML documentation of the source code in the directory 'docs'.
Make sure the 'ldoc' program is installed on your machine and the LDOC variable in the script points there.
On OSX, this can be accomplished by installing it through luarocks (run `sudo luarocks install ldoc`). Luarocks can be installed using [MacPorts](http://www.macports.org/). After installing that, the command would be `sudo port install luarocks`.