From 53364ddc2e09362cb17432abf4fb598557554a9f Mon Sep 17 00:00:00 2001 From: chai Date: Sat, 30 Oct 2021 11:42:13 +0800 Subject: + LDoc --- Data/Libraries/LDoc/tests/submodule/config.ld | 2 ++ .../Libraries/LDoc/tests/submodule/mylib/extra.lua | 13 ++++++++ Data/Libraries/LDoc/tests/submodule/mylib/init.lua | 35 ++++++++++++++++++++++ 3 files changed, 50 insertions(+) create mode 100644 Data/Libraries/LDoc/tests/submodule/config.ld create mode 100644 Data/Libraries/LDoc/tests/submodule/mylib/extra.lua create mode 100644 Data/Libraries/LDoc/tests/submodule/mylib/init.lua (limited to 'Data/Libraries/LDoc/tests/submodule') diff --git a/Data/Libraries/LDoc/tests/submodule/config.ld b/Data/Libraries/LDoc/tests/submodule/config.ld new file mode 100644 index 0000000..8369015 --- /dev/null +++ b/Data/Libraries/LDoc/tests/submodule/config.ld @@ -0,0 +1,2 @@ +file = {'mylib/init.lua','mylib/extra.lua'} +if foo then print 'foo' end diff --git a/Data/Libraries/LDoc/tests/submodule/mylib/extra.lua b/Data/Libraries/LDoc/tests/submodule/mylib/extra.lua new file mode 100644 index 0000000..bb06b40 --- /dev/null +++ b/Data/Libraries/LDoc/tests/submodule/mylib/extra.lua @@ -0,0 +1,13 @@ +----------- +-- Extra module +-- @submodule mylib + +--- will appear in mylib's docs! +function E () + +end + +--- ditto +function F () + +end diff --git a/Data/Libraries/LDoc/tests/submodule/mylib/init.lua b/Data/Libraries/LDoc/tests/submodule/mylib/init.lua new file mode 100644 index 0000000..83bc90a --- /dev/null +++ b/Data/Libraries/LDoc/tests/submodule/mylib/init.lua @@ -0,0 +1,35 @@ +----------- +-- Main module. +-- This contains four functions, two of which are in +-- another section implicitly specified using the 'within' tag. +-- (This allows functions placed together to be classified +-- separately) +-- +-- Furthermore, the 'mylib.extra' functions will be added +-- as their own section, allowing you to document a logical module +-- spanning several files +-- +-- @module mylib + +--- first. +function A () + +end + +--- second, within its own section. +-- @within Utilities +function B () + +end + +--- third. +function C () + +end + +--- fourth, together with second. +-- @within Utilities +function D () + +end + -- cgit v1.1-26-g67d0