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

Rewrite of first introductory paragraph 

A suggested rewrite of first introductory paragraph. It does drop some information (e.g. second generation) in favor of being more beginner's friendly and more basic in what this is actually about. The followup LDoc-referring paragraphs seem sufficient to cater the needs of advanced doc tool users, while the first paragraph possibly stumps and scares away beginners in its current form.
This commit is contained in:
JonasT 2013-12-31 08:18:33 +01:00
parent 2db76970ab
commit 721d626b70
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
LDoc is a second-generation documentation tool that can be used as a replacement for
[LuaDoc](http://keplerproject.github.com/luadoc/). It arose out of my need to document my
own projects and only depends on the [Penlight](https://github.com/stevedonovan/Penlight)
libraries.
LDoc is a software documentation tool which automatically generates API documentation
out of source code comments (doc comments). It is mainly targeted at Lua and documenting
Lua APIs, but it can also parse C with according doc comments for documenting Lua modules
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
`module` function; this is not only a matter of taste since this has been deprecated in Lua
5.2.