asciidoc

package

Go to main page

Versions in this module

v0

v0.4.7

Aug 28, 2023

v0.4.6

Sep 27, 2021

v0.4.5

Apr 9, 2021

v0.4.4

Apr 9, 2021

v0.4.3

Mar 27, 2021

v0.4.2

Mar 21, 2021

v0.4.1

Mar 21, 2021

Changes in this version

type Producer

+ func (p *Producer) EnableMacro() *Producer

v0.4.0

Mar 19, 2021

v0.3.0

Oct 21, 2020

Changes in this version

type Producer

+ func (p *Producer) NonExported() *Producer

type TemplateContext

+ func (t *TemplateContext) RenderPrivate() *TemplateContext

type TemplateContextConfig

+ Private bool

v0.2.1

Oct 21, 2020

v0.2.0

Oct 21, 2020

Changes in this version

type Producer

+ func (p *Producer) PackageDoc(filepath ...string) *Producer

type TemplateContext

+ Package *goparser.GoPackage

+ Receiver []*goparser.GoStructMethod

+ func (t *TemplateContext) RenderReceiverFunctions(wr io.Writer, receiver string) *TemplateContext

type TemplateType

+ const ReceiversTemplate

v0.1.0

Oct 7, 2020

Changes in this version

type Producer

+ func (p *Producer) PackgeDoc(filepath ...string) *Producer

type TemplateContext

+ Docs map[string]string

type TemplateContextConfig

+ PackageOverviewPaths []string

v0.0.9

Oct 6, 2020

v0.0.8

Oct 6, 2020

Changes in this version

type Producer

+ func (p *Producer) CreateTemplateWithOverrides() *Template

+ type TemplateAndText struct

+ Template *template.Template

+ Text string

v0.0.7

Oct 6, 2020

v0.0.6

Oct 6, 2020

v0.0.5

Oct 5, 2020

Changes in this version

type Producer

+ func (p *Producer) NoToc() *Producer

v0.0.4

Oct 2, 2020

v0.0.3

Oct 1, 2020

v0.0.2

Oct 1, 2020

v0.0.1

Oct 1, 2020

Changes in this version

+ type IndexConfig struct

+ AuthorEmail string

+ AuthorName string

+ DocType string

+ Highlighter string

+ HomePage string

+ ImageDir string

+ Title string

+ TocLevels int

+ TocTitle string

+ Version string

+ type Producer struct

+ func NewProducer() *Producer

+ func (p *Producer) Generate()

+ func (p *Producer) Include(path ...string) *Producer

+ func (p *Producer) IncludeInternal() *Producer

+ func (p *Producer) IncludeTest() *Producer

+ func (p *Producer) IncludeUnderScoreDirectories() *Producer

+ func (p *Producer) IndexConfig(overrides string) *Producer

+ func (p *Producer) Module(path string) *Producer

+ func (p *Producer) NoIndex() *Producer

+ func (p *Producer) Outfile(path string) *Producer

+ func (p *Producer) Override(name, template string) *Producer

+ func (p *Producer) OverrideFilePath(name, path string) *Producer

+ func (p *Producer) StdOut() *Producer

+ func (p *Producer) Writer(w io.Writer) *Producer

+ type Template struct

+ Templates map[string]*template.Template

+ func NewTemplate() *Template

+ func NewTemplateWithOverrides(overrides map[string]string) *Template

+ func (t *Template) NewContext(f *goparser.GoFile) *TemplateContext

+ func (t *Template) NewContextWithConfig(f *goparser.GoFile, config *TemplateContextConfig) *TemplateContext

+ type TemplateContext struct

+ Config *TemplateContextConfig

+ ConstAssignment *goparser.GoAssignment

+ File *goparser.GoFile

+ Function *goparser.GoStructMethod

+ Index *IndexConfig

+ Interface *goparser.GoInterface

+ Module *goparser.GoModule

+ Struct *goparser.GoStruct

+ TypeDefFunc *goparser.GoMethod

+ TypeDefVar *goparser.GoCustomType

+ VarAssignment *goparser.GoAssignment

+ func (t *TemplateContext) Clone(clean bool) *TemplateContext

+ func (t *TemplateContext) Creator() *Template

+ func (t *TemplateContext) DefaultIndexConfig(overrides string) *IndexConfig

+ func (t *TemplateContext) RenderConstDeclaration(wr io.Writer, a *goparser.GoAssignment) *TemplateContext

+ func (t *TemplateContext) RenderConstDeclarations(wr io.Writer) *TemplateContext

+ func (t *TemplateContext) RenderFunction(wr io.Writer, f *goparser.GoStructMethod) *TemplateContext

+ func (t *TemplateContext) RenderFunctions(wr io.Writer) *TemplateContext

+ func (t *TemplateContext) RenderImports(wr io.Writer) *TemplateContext

+ func (t *TemplateContext) RenderIndex(wr io.Writer, ic *IndexConfig) *TemplateContext

+ func (t *TemplateContext) RenderInterface(wr io.Writer, i *goparser.GoInterface) *TemplateContext

+ func (t *TemplateContext) RenderInterfaces(wr io.Writer) *TemplateContext

+ func (t *TemplateContext) RenderPackage(wr io.Writer) *TemplateContext

+ func (t *TemplateContext) RenderStruct(wr io.Writer, s *goparser.GoStruct) *TemplateContext

+ func (t *TemplateContext) RenderStructs(wr io.Writer) *TemplateContext

+ func (t *TemplateContext) RenderTypeDefFunc(wr io.Writer, td *goparser.GoMethod) *TemplateContext

+ func (t *TemplateContext) RenderTypeDefFuncs(wr io.Writer) *TemplateContext

+ func (t *TemplateContext) RenderVarDeclaration(wr io.Writer, a *goparser.GoAssignment) *TemplateContext

+ func (t *TemplateContext) RenderVarDeclarations(wr io.Writer) *TemplateContext

+ func (t *TemplateContext) RenderVarTypeDef(wr io.Writer, td *goparser.GoCustomType) *TemplateContext

+ func (t *TemplateContext) RenderVarTypeDefs(wr io.Writer) *TemplateContext

+ type TemplateContextConfig struct

+ IncludeMethodCode bool

+ type TemplateType string

+ const ConstDeclarationTemplate

+ const ConstDeclarationsTemplate

+ const CustomFuncTypeDefTemplate

+ const CustomFuncTypeDefsTemplate

+ const CustomVarTypeDefTemplate

+ const CustomVarTypeDefsTemplate

+ const FunctionTemplate

+ const FunctionsTemplate

+ const ImportTemplate

+ const IndexTemplate

+ const InterfaceTemplate

+ const InterfacesTemplate

+ const PackageTemplate

+ const StructTemplate

+ const StructsTemplate

+ const VarDeclarationTemplate

+ const VarDeclarationsTemplate

+ func (tt TemplateType) String() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL