Modül:Docbunto/tags

Token dictionary for Docbunto tags. Maps Docbunto tag names to tag tokens.

• Multi-line tags use the 'M' token.
• Multi-line preformatted tags use the 'ML' token.
• Identifier tags use the 'ID' token.
• Single-line tags use the 'S' token.
• Flags use the 'N' token.
• Type tags use the 'T' token.

--- Token dictionary for Docbunto tags.
--  Maps Docbunto tag names to tag tokens.
--   * Multi-line tags use the 'M' token.
--   * Multi-line preformatted tags use the 'ML' token.
--   * Identifier tags use the 'ID' token.
--   * Single-line tags use the 'S' token.
--   * Flags use the 'N' token.
--   * Type tags use the 'T' token.
--  @module             docbunto_tags
return {
	-- Item-level tags, available for global use.
	['param'] = 'M', ['see'] = 'M', ['note'] = 'M', ['usage'] = 'ML',
	['description'] = 'M', ['field'] = 'M', ['return'] = 'M',
	['fixme'] = 'M', ['todo'] = 'M', ['warning'] = 'M', ['error'] = 'M';
	['class'] = 'ID', ['name'] = 'ID', ['alias'] = 'ID';
	['summary'] = 'S', ['factory'] = 'S',
	['release'] = 'S', ['author'] = 'S', ['copyright'] = 'S', ['license'] = 'S',
	['require'] = 'S', ['attribution'] = 'S',
	['credit'] = 'S', ['demo'] = 'S';
	['local'] = 'N', ['export'] = 'N', ['private'] = 'N', ['constructor'] = 'N',
	['static'] = 'N';
	-- Project-level tags, all scoped to a file.
	['module'] = 'T', ['script'] = 'T', ['classmod'] = 'T', ['topic'] = 'T',
	['submodule'] = 'T', ['example'] = 'T', ['file'] = 'T';
	-- Module-level tags, used to register module items.
	['function'] = 'T', ['table'] = 'T', ['member'] = 'T', ['variable'] = 'T',
	['section'] = 'T', ['type'] = 'T';

	_alias = {
		-- Normal aliases.
		['about']       = 'summary',
		['abstract']    = 'summary',
		['brief']       = 'summary',
		['bug']         = 'fixme',
		['argument']    = 'param',
		['credits']     = 'credit',
		['code']        = 'usage',
		['details']     = 'description',
		['discussion']  = 'description',
		['exception']   = 'error',
		['lfunction']   = 'function',
		['package']     = 'module',
		['property']    = 'member',
		['raise']       = 'error',
		['requires']    = 'require',
		['returns']     = 'return',
		['throws']      = 'error',
		['typedef']     = 'type',
		-- Typed aliases.
		['bool']        = 'field',
		['func']        = 'field',
		['int']         = 'field',
		['number']      = 'field',
		['string']      = 'field',
		['tab']         = 'field',
		['vararg']      = 'param',
		['tfield']      = 'field',
		['tparam']      = 'param',
		['treturn']     = 'return'
	},
	_type_alias = {
		-- Implicit type value alias.
		['bool']        = 'boolean',
		['func']        = 'function',
		['int']         = 'number',
		['number']      = 'number',
		['string']      = 'string',
		['tab']         = 'table',
		['vararg']      = '...',
		-- Pure typed modifier alias.
		['tfield']      = 'variable',
		['tparam']      = 'variable',
		['treturn']     = 'variable'
	},
	_project_level = {
		-- Contains code.
		['module']      = true,
		['script']      = true,
		['classmod']    = true,
		['submodule']   = true,
		['file']        = true,
		-- Contains documentation.
		['topic']       = true,
		['example']     = true
	},
	_code_types = {
		['module']      = true,
		['script']      = true,
		['classmod']    = true
	},
	_module_info = {
		['image']       = true,
		['caption']     = true,
		['release']     = true,
		['author']      = true,
		['copyright']   = true,
		['license']     = true,
		['require']     = true,
		['credit']      = true,
		['attribution'] = true,
		['demo']        = true
	},
	_annotation_tags = {
		['warning']     = true,
		['fixme']       = true,
		['note']        = true,
		['todo']        = true,
		['see']         = true
	},
	_privacy_tags = {
		['private']     = true,
		['local']       = true
	},
	_generic_tags = {
		['variable']    = true,
		['member']      = true
	},
	_subtype_tags = {
		['factory']     = true,
		['local']       = true,
		['private']     = true,
		['constructor'] = true,
		['static']      = true
	},
	_subtype_hierarchy = {
		'private',
		'local',
		'static',
		'factory',
		'constructor'
	},
}