Skip to content
This repository has been archived by the owner on Nov 20, 2020. It is now read-only.

Commit

Permalink
Merge pull request lunarmodules#141 from JonasT/patch-2
Browse files Browse the repository at this point in the history
Rewrite of first introductory paragraph
  • Loading branch information
stevedonovan committed Dec 31, 2013
2 parents 2db7697 + 721d626 commit 2d6cddc
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions doc/doc.md
Expand Up @@ -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.
Expand Down

0 comments on commit 2d6cddc

Please sign in to comment.