docs.md

docs

module

• data ConstantDocs
• data DataDocs
• data DataFieldDocs
• data EnumCaseDocs
• data EnumDocs
• data ExternFieldDocs
• data ExternFunctionDocs
• data ExternTypeDocs
• data FunctionDocs
• data ModuleDocs
• enum TypeDocs
• func docsToMarkdown docs
• func docsToMarkup
• extern inspect value

ConstantDocs

data The documentation of a constant declaration. If a constant resolves to a function, it can still be called.

/// The docs string
let constantName = 42

Properties

• name - The name of the constant declaration.
• docs - The docs as text.

DataDocs

data The documentation of a data declaration.

/// The docs string
data DataName {
   someFields with, params
   orWithout
}

Properties

• name - The name of the data declaration
• docs - The docs as text.
• fields - A List of fields of DataFieldDocs

DataFieldDocs

data Describes a field of a data type

Properties

• name - name of the data property
• docs - The docs as text.
• params - A List of the data field's parameter names. Can be treated as function if not Nil.

EnumCaseDocs

data The documentation for a specific enum case.

Properties

• name - The name of the enum case.
• docs - The docs as text.
• type - The underlaying type of the enum case.

EnumDocs

data Contains all documentation information for a given enum.

Properties

• name - Name of the enum.
• docs - The docs as text.
• cases - Each enum case as EnumCaseDocs.

ExternFieldDocs

data Describes a field of a data type

Properties

• name - name of the data property
• docs - The docs as text.
• params - A List of the extern field's parameter names. Can be treated as function if not Nil.

ExternFunctionDocs

data The documentation of an extern function declaration.

/// The docs string
extern externFunctionName params, asList

Properties

• name - The name of the external function.
• docs - The docs as text.
• params - A list of its paramter names. Can be treated as constant if Nil.

ExternTypeDocs

data The documentation of an extern type declaration.

/// The docs string
extern ExternTypeName {
   someFields with, params
   orWithout
}

Properties

• name - The name of the external type.
• docs - The docs as text.
• fields - a list of ExternFieldDocs.

FunctionDocs

data The documentation of a function declaration.

/// The docs string
func functionName { params => }

Properties

• name - name of the function.
• docs - The docs as text.
• params - A list of the function's parameter names.

ModuleDocs

data The documentation of a module declaration.

/// The docs string
module internalModuleName

Properties

• name - name of the module
• types - all types declared in the module
• docs - The docs as text.

TypeDocs

enum All possible docs inspection values.

Cases

• EnumDocs
• DataDocs
• ModuleDocs
• FunctionDocs
• ConstantDocs
• ExternTypeDocs
• ExternFunctionDocs
• None

docsToMarkdown

func docsToMarkdown docs

docsToMarkup

func docsToMarkup

inspect

func inspect value

Inspects a given value for documentation. @returns TypeDocs