Documentation
Package items
Documentation
Describes the overall structure of the content in the Lua module or topic. It's a collection of all the information the taglet outputs - including a Hashmap of tags in the module comments. It is similar to the Documentation object JSDoc generates for files.
Documentation.summary(member • string)- The first sentence of the byline comments describing the module. This text is parsed from the top of the module page's content.
- TODO: Deprecate this for compatibility with JSDoc.
Documentation.description(member • string)- The full paragraph of the comment preface describing the module. This field is terminous with the
summaryfield - the first sentence appears removed when summary is present. Documentation.comments(member • sequence<string>)- List of comments that appear at the top of the module page's content.
Documentation.code(member • string)- The full text contents of the module page. This will have boilerplate comments removed. Boilerplate comments appear as block comments at the end or start of the page.
Other items
--- @topic docbunto
--- Describes the overall structure of the content in the Lua module
-- or topic. It's a collection of all the information the
-- taglet outputs - including a @{Hashmap} of tags in the module
-- comments. It is similar to the Documentation object JSDoc
-- generates for files.
-- @type Documentation
-- @todo Add tokens field.
--- The first sentence of the byline comments describing the module.
-- This text is parsed from the top of the module page's content.
-- @member {string} Documentation.summary
-- @todo **Deprecate** this for compatibility with JSDoc.
--- The full paragraph of the comment preface describing the module.
-- This field is terminous with the `summary` field - the first sentence
-- appears removed when summary is present.
-- @member {string} Documentation.description
--- List of comments that appear at the top of the module page's content.
-- @member {sequence<string>} Documentation.comments
--- The full text contents of the module page. This will have boilerplate
-- comments removed. Boilerplate comments appear as block comments at
-- the end or start of the page.
-- @member {string} Documentation.code
--- A sequence of object tables that is also indexable by the name
-- key of each object. Indexing by name produces a list of the
-- objects with that name key.
-- @type Hashmap