Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetFormatNames ¶
func GetFormatNames() []string
GetFormatNames returns a list of available format names
Types ¶
type MarkdownFormat ¶
type MarkdownFormat struct{}
MarkdownFormat implements the generator.Format interface for Markdown output
func (*MarkdownFormat) Extension ¶
func (f *MarkdownFormat) Extension() string
Extension returns the file extension for Markdown
func (*MarkdownFormat) Name ¶
func (f *MarkdownFormat) Name() string
Name returns the name of the format
func (*MarkdownFormat) Render ¶
func (f *MarkdownFormat) Render(data generator.TemplateData) (string, int, error)
Render converts the template data into Markdown format
type TxtFormat ¶
type TxtFormat struct{}
TxtFormat implements the generator.Format interface for plain text output
type XMLDirectory ¶
type XMLDirectory struct {
Name string `xml:"name,attr"`
Directories []XMLDirectory `xml:"directory,omitempty"`
Files []XMLFileRef `xml:"file,omitempty"`
}
XMLDirectory represents a directory in the structure
type XMLFile ¶
type XMLFile struct {
Path string `xml:"path,attr"`
Language string `xml:"language,attr"`
Content string `xml:",cdata"`
}
XMLFile represents a file with its content
type XMLFileRef ¶
type XMLFileRef struct {
Name string `xml:"name,attr"`
}
XMLFileRef represents a file reference in the directory structure
type XMLFilesystem ¶
type XMLFilesystem struct {
Root XMLDirectory `xml:"directory"`
}
XMLFilesystem represents the directory structure
type XMLFormat ¶
type XMLFormat struct{}
XMLFormat implements the generator.Format interface for XML output
type XMLProject ¶
type XMLProject struct {
XMLName xml.Name `xml:"project"`
Filesystem XMLFilesystem `xml:"filesystem"`
Files []XMLFile `xml:"files>file"`
}
XMLProject represents the root XML element
Source Files
Click to show internal directories.
Click to hide internal directories.