optdesc

Documentation

Index

• Constants
• Variables
• func ExtractOptDescription(docbook *docbook.ManDocBookXml, writer io.Writer) (model schema.OptDescriptionModel)
• type SectionParser
  • func (parser *SectionParser) AggregateExtracts(sec *section.Section) extractor.RawOptExtracts
  • func (parser *SectionParser) ExtractModel(sec *section.Section, writer io.Writer) schema.OptDescriptionModel

Constants

const (
	DocbookNodeVariableList   = "variablelist"
	DocbookNodeParagraph      = "para"
	DocbookNodeLiteralLayout  = "literallayout"
	DocbookNodeProgramListing = "programlisting"
	DocbookNodeBlockQuote     = "blockquote"
)

Variables

var DescriptionSectionParser = SectionParser{
	TargetSection: descriptionSectionName,
	// contains filtered or unexported fields
}

var OptionSectionParser = SectionParser{
	TargetSection: optionSectionName,
	// contains filtered or unexported fields
}

Functions

func ExtractOptDescription

func ExtractOptDescription(docbook *docbook.ManDocBookXml, writer io.Writer) (model schema.OptDescriptionModel)

This function does its best to extract an option description model from a docbook structure. Writer argument can be either nil (no logging) or an io.Writer to write failures and guesses. Returns nil if cannot find any opt description

Types

type SectionParser

type SectionParser struct {
	TargetSection string
	// contains filtered or unexported fields
}

func (*SectionParser) AggregateExtracts

func (parser *SectionParser) AggregateExtracts(sec *section.Section) extractor.RawOptExtracts

func (*SectionParser) ExtractModel

func (parser *SectionParser) ExtractModel(sec *section.Section, writer io.Writer) schema.OptDescriptionModel