Initial ldoc support

10 files changed, 44 insertions, 1 deletions

diff --git a/.gitignore b/.gitignore
index 9e8fae7..bb49351 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,4 @@
 luacov.*.out
 test/test_repo
 lib/gall/ll/git2.so
+html/
diff --git a/config.ld b/config.ld
new file mode 100644
index 0000000..b23b04f
--- /dev/null
+++ b/config.ld
@@ -0,0 +1,6 @@
+file = {"lib"}
+readme = "README"
+format = "lua-markdown"
+project = "Git Abstraction Layer for Lua"
+title = "Gall - Git Abstraction Layer for Lua"
+dir = "html"
diff --git a/lib/gall.lua b/lib/gall.lua
index a2f613a..397f97c 100644
--- a/lib/gall.lua
+++ b/lib/gall.lua
@@ -5,6 +5,11 @@
 -- Copyright 2012 Daniel Silverstone <dsilvers@digital-scurf.org>
 --
 
+---
+-- Git Abstraction Layer for Lua
+--
+-- @module gall
+
 local API_VERSION = 0
 local ABI_VERSION = 0
 
diff --git a/lib/gall/commit.lua b/lib/gall/commit.lua
index 13e3556..bd6f341 100644
--- a/lib/gall/commit.lua
+++ b/lib/gall/commit.lua
@@ -6,6 +6,11 @@
 --
 --
 
+---
+-- Commit object interface
+--
+-- @module gall.commit
+
 local ll = require "gall.ll"
 
 local objs = setmetatable({}, {__mode="k"})
diff --git a/lib/gall/ll.lua b/lib/gall/ll.lua
index 3a24250..839669d 100644
--- a/lib/gall/ll.lua
+++ b/lib/gall/ll.lua
@@ -6,6 +6,12 @@
 --
 --
 
+---
+-- Low level interface to Git
+--
+-- @module gall.ll
+
+
 local sp = require "luxio.subprocess"
 local util = require "gall.util"
 
diff --git a/lib/gall/object.lua b/lib/gall/object.lua
index f59fb39..32db03d 100644
--- a/lib/gall/object.lua
+++ b/lib/gall/object.lua
@@ -6,6 +6,11 @@
 --
 --
 
+---
+-- Generic object interface
+--
+-- @module gall.object
+
 local ll = require "gall.ll"
 local commit = require "gall.commit"
 local tree = require "gall.tree"
diff --git a/lib/gall/repository.lua b/lib/gall/repository.lua
index e725861..f5dac66 100644
--- a/lib/gall/repository.lua
+++ b/lib/gall/repository.lua
@@ -6,6 +6,11 @@
 --
 --
 
+---
+-- Repository interface
+--
+-- @module gall.repository
+
 local ll = require "gall.ll"
 local object = require "gall.object"
 local tree = require "gall.tree"
diff --git a/lib/gall/tag.lua b/lib/gall/tag.lua
index 0ea0cba..e0c3c3a 100644
--- a/lib/gall/tag.lua
+++ b/lib/gall/tag.lua
@@ -6,6 +6,11 @@
 --
 --
 
+---
+-- Tag object interface
+--
+-- @module gall.tag
+
 local ll = require "gall.ll"
 
 local objs = setmetatable({}, {__mode="k"})
diff --git a/lib/gall/tree.lua b/lib/gall/tree.lua
index a44b333..ac13dc3 100644
--- a/lib/gall/tree.lua
+++ b/lib/gall/tree.lua
@@ -6,6 +6,11 @@
 --
 --
 
+---
+-- Tree object interface
+--
+-- @module gall.tree
+
 local ll = require "gall.ll"
 
 local PARSED = {}
diff --git a/lib/gall/util.lua b/lib/gall/util.lua
index 48181be..8aba18b 100644
--- a/lib/gall/util.lua
+++ b/lib/gall/util.lua
@@ -1,4 +1,4 @@
--- gall.ll
+-- gall.util
 --
 -- Git Abstraction Layer for Lua -- Utility functions
 --