Initial import of LDoc version 1.3.4
Julian Wollrath
11 years ago
0 | lua-ldoc (1.3.4-1) unstable; urgency=low | |
1 | ||
2 | * Initial release. (Closes: #700489) | |
3 | ||
4 | -- Julian Wollrath <jwollrath@web.de> Fri, 15 Feb 2013 00:29:59 +0100 |
0 | 9 |
0 | Source: lua-ldoc | |
1 | Section: interpreters | |
2 | Priority: optional | |
3 | Maintainer: Julian Wollrath <jwollrath@web.de> | |
4 | Build-Depends: debhelper (>= 9), dh-lua | |
5 | Standards-Version: 3.9.4 | |
6 | Homepage: http://stevedonovan.github.com/ldoc/ | |
7 | ||
8 | Package: lua-ldoc | |
9 | Architecture: all | |
10 | Depends: ${misc:Depends}, lua5.1 | lua5.2, lua-penlight | |
11 | XB-Lua-Versions: ${lua:Versions} | |
12 | Description: LuaDoc-compatible documentation generation system | |
13 | LDoc is a LuaDoc-compatible documentation generation system for Lua source | |
14 | code. It parses the declaration and documentation comments in a set of Lua | |
15 | source files and produces a set of XHTML pages describing the commented | |
16 | declarations and functions. |
0 | Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ | |
1 | Upstream-Name: LDoc | |
2 | Upstream-Contact: steve.j.donovan@gmail.com | |
3 | Source: https://github.com/stevedonovan/LDoc | |
4 | ||
5 | Files: * | |
6 | Copyright: 2011 Steve Donovan | |
7 | Comment: In the Lua community this license is better known as "MIT". | |
8 | Unfortunately other variants of this license are also known as "MIT". | |
9 | To obtain a machine intepretable copyright file Debian prefers to name this | |
10 | version of the MIT license using the non ambiguous term "Expat". | |
11 | License: Expat | |
12 | ||
13 | Files: debian/* | |
14 | Copyright: 2013 Julian Wollrath <jwollrath@web.de> | |
15 | License: Expat | |
16 | ||
17 | License: Expat | |
18 | Permission is hereby granted, free of charge, to any person obtaining a copy | |
19 | of this software and associated documentation files (the "Software"), to deal | |
20 | in the Software without restriction, including without limitation the rights | |
21 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
22 | copies of the Software, and to permit persons to whom the Software is | |
23 | furnished to do so, subject to the following conditions: | |
24 | . | |
25 | The above copyright notice and this permission notice shall be included in | |
26 | all copies or substantial portions of the Software. | |
27 | . | |
28 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
29 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
30 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
31 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
32 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
33 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
34 | THE SOFTWARE. |
0 | docs/doc.md |
0 | .TH LDOC "1" "February 2013" "ldoc 1.3.4" "User Commands" | |
1 | .SH NAME | |
2 | ldoc \- A LuaDoc-compatible documentation generation system | |
3 | .SH DESCRIPTION | |
4 | LDoc, a documentation generator for Lua compatible to LuaDoc. | |
5 | .HP | |
6 | \fB\-d\fR, \-\-dir | |
7 | (default docs) output directory | |
8 | .TP | |
9 | \fB\-o\fR, \-\-output | |
10 | (default 'index') output name | |
11 | .TP | |
12 | \fB\-v\fR, \-\-verbose | |
13 | verbose | |
14 | .TP | |
15 | \fB\-a\fR, \-\-all | |
16 | show local functions, etc, in docs | |
17 | .TP | |
18 | \fB\-q\fR, \-\-quiet | |
19 | suppress output | |
20 | .TP | |
21 | \fB\-m\fR, \-\-module | |
22 | module docs as text | |
23 | .HP | |
24 | \fB\-s\fR, \-\-style | |
25 | (default !) directory for style sheet (ldoc.css) | |
26 | .HP | |
27 | \fB\-l\fR, \-\-template | |
28 | (default !) directory for template (ldoc.ltp) | |
29 | .TP | |
30 | \fB\-1\fR, \-\-one | |
31 | use one\-column output layout | |
32 | .HP | |
33 | \fB\-p\fR, \-\-project | |
34 | (default ldoc) project name | |
35 | .HP | |
36 | \fB\-t\fR, \-\-title | |
37 | (default Reference) page title | |
38 | .HP | |
39 | \fB\-f\fR, \-\-format | |
40 | (default plain) formatting \- can be markdown, discount or plain | |
41 | .TP | |
42 | \fB\-b\fR, \-\-package | |
43 | (default .) top\-level package basename (needed for module(...)) | |
44 | .HP | |
45 | \fB\-x\fR, \-\-ext | |
46 | (default html) output file extension | |
47 | .HP | |
48 | \fB\-c\fR, \-\-config | |
49 | (default config.ld) configuration name | |
50 | .HP | |
51 | \fB\-i\fR, \-\-ignore | |
52 | ignore any 'no doc comment or no module' warnings | |
53 | .HP | |
54 | \fB\-D\fR, \-\-define | |
55 | (default none) set a flag to be used in config.ld | |
56 | .HP | |
57 | \fB\-C\fR, \-\-colon | |
58 | use colon style | |
59 | .HP | |
60 | \fB\-B\fR, \-\-boilerplate | |
61 | ignore first comment in source files | |
62 | .HP | |
63 | \fB\-M\fR, \-\-merge | |
64 | allow module merging | |
65 | .TP | |
66 | \fB\-\-dump\fR | |
67 | debug output dump | |
68 | .HP | |
69 | \fB\-\-filter\fR (default none) filter output as Lua data (e.g pl.pretty.dump) | |
70 | .HP | |
71 | \fB\-\-tags\fR (default none) show all references to given tags, comma\-separated | |
72 | .HP | |
73 | \fB<file>\fR | |
74 | (string) source file or directory containing source | |
75 | .SH "Examples" | |
76 | `ldoc .` reads options from an `config.ld` file in same directory | |
77 | .HP | |
78 | `ldoc -c path/to/myconfig.ld .` reads options from `path/to/myconfig.ld` | |
79 | .SH "Author" | |
80 | This manpage was written for Debian by Julian Wollrath. |
0 | usr/share/lua/5.1/ldoc.lua usr/bin/ldoc |
0 | missing-dep-for-interpreter |
0 | debian/ldoc.1 |
0 | PKG_NAME=ldoc | |
1 | LUA_MODNAME=ldoc | |
2 | LUA_SOURCES=$(wildcard ldoc/*/*.lua && wildcard ldoc/*.lua && wildcard *.lua) |
0 | lua5.1.dh-lua.conf⏎ |
0 | #!/usr/bin/make -f | |
1 | ||
2 | %: | |
3 | dh $@ --buildsystem=lua --with lua --parallel | |
4 | ||
5 | override_dh_auto_test: | |
6 | cd tests && for LUA in lua5.1 lua5.2; \ | |
7 | do \ | |
8 | $${LUA} ../ldoc.lua . && echo ok && \ | |
9 | for DIR in example md-test merge submodule; \ | |
10 | do \ | |
11 | cd $${DIR} && $${LUA} ../../ldoc.lua . && \ | |
12 | echo ok && cd ..; \ | |
13 | done; \ | |
14 | done | |
15 | ||
16 | override_dh_prep: | |
17 | chmod +x ldoc.lua | |
18 | dh_prep | |
19 | ||
20 | override_dh_clean: | |
21 | dh_clean | |
22 | rm -rf tests/docs tests/*/docs | |
23 | rm -f debian/trash | |
24 | chmod -x ldoc.lua |
0 | 3.0 (quilt) |