Aire-One
/
LDoc2tl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #141 from JonasT/patch-2 

Rewrite of first introductory paragraph
This commit is contained in:
Steve J Donovan 2013-12-31 00:59:22 -08:00
parent 2db76970ab 721d626b70
commit 2d6cddce44
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/doc.md
View File

@ -4,12 +4,13 @@
## Introduction ## Introduction
LDoc is a second-generation documentation tool that can be used as a replacement for LDoc is a software documentation tool which automatically generates API documentation
[LuaDoc](http://keplerproject.github.com/luadoc/). It arose out of my need to document my out of source code comments (doc comments). It is mainly targeted at Lua and documenting
own projects and only depends on the [Penlight](https://github.com/stevedonovan/Penlight) Lua APIs, but it can also parse C with according doc comments for documenting Lua modules
libraries. implemented in C.
It is mostly compatible with LuaDoc, except that certain workarounds are no longer needed. It is mostly compatible with [LuaDoc](http://keplerproject.github.com/luadoc/),
except that certain workarounds are no longer needed.
For instance, it is not so married to the idea that Lua modules should be defined using the For instance, it is not so married to the idea that Lua modules should be defined using the
`module` function; this is not only a matter of taste since this has been deprecated in Lua `module` function; this is not only a matter of taste since this has been deprecated in Lua
5.2. 5.2.