Documentation
¶
Overview ¶
generator.go
highlight.go
parser.go
types.go
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type PackageDoc ¶
type PackageDoc struct {
Name string
RepositoryUrl string
Version string
ImportPath string
StyleSheetPath string
Doc string
Functions []FuncDoc
Types []TypeDoc
Variables []VarDoc
Constants []VarDoc
SubPackages []string
}
PackageDoc holds all the documentation for a single package.
func ParsePackageDoc ¶ added in v1.1.9
func ParsePackageDoc(inputPath string) (*PackageDoc, error)
ParsePackageDoc parses the Go package in the given directory and returns an initialized PackageDoc. It does not populate metadata fields like RepositoryUrl or Version.
func (*PackageDoc) IsEmpty ¶ added in v1.0.2
func (p *PackageDoc) IsEmpty() bool
IsEmpty reports whether the package documentation is empty (has no content).
func (*PackageDoc) Render ¶ added in v1.1.4
func (p *PackageDoc) Render(outputPath string) error
Render generates the HTML documentation file using the embedded template.
type TypeDoc ¶
type TypeDoc struct {
Constants []VarDoc // Constants grouped under this type
Definition template.HTML
Doc string
Functions []FuncDoc // Constructors/factory functions associated with this type.
Methods []FuncDoc
Name string
Variables []VarDoc // Variables grouped under this type
}
TypeDoc holds documentation for a type definition and its methods.
Click to show internal directories.
Click to hide internal directories.