Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add test using type in @module and @submodule #378

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions tests/type/SimpleModule.lua
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
-----------
-- Simple module.
-- This contains two types `Type1InModule` and `Type2InModule`,
-- that are both listed as classes in the generated docs.
-- @module CombinedModule

--- Type1InModule description.
-- @type Type1InModule
Type1InModule = {}

--- Type1InModule:A description.
function Type1InModule:A()

end

--- Type2InModule description.
-- @type Type2InModule
Type2InModule = {}

--- Type2InModule:A description.
function Type2InModule:B()

end
12 changes: 12 additions & 0 deletions tests/type/Submodule_extra.lua
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
-----------
-- Simple module distributed across two files.
-- @submodule DistributedModule

--- Type2InSubmodule description.
-- @type Type2InSubmodule
Type2InSubmodule = {}

--- Type2InSubmodule:B description.
function Type2InSubmodule:B()

end
15 changes: 15 additions & 0 deletions tests/type/Submodule_init.lua
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
-----------
-- Simple module distributed across two files.
-- This contains two types `Type1InSubmodule` and `Type2InSubmodule`.
-- While `Type1InSubmodule` is listed as a class in the generated docs,
-- `Type2InSubmodule` is not. Instead only its functions are listed.
-- @module DistributedModule

--- Type1InSubmodule description.
-- @type Type1InSubmodule
Type1InSubmodule = {}

--- Type1InSubmodule:A description.
function Type1InSubmodule:A()

end
1 change: 1 addition & 0 deletions tests/type/config.ld
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
file = {'SimpleModule.lua','Submodule_init.lua','Submodule_extra.lua'}