cmt

Documentation

Overview

Package cmt provides functions that parse and render GIR comments into nice and conventional Go comments.

Index

• Constants
• func EnsureInfoFields(v interface{}) struct{}
• func GoDoc(v interface{}, indentLvl int, opts ...Option) string
• func Synopsis(v interface{}, indentLvl int, opts ...Option) string
• type InfoFields
  • func GetInfoFields(v interface{}) InfoFields
• type Option
  • func AdditionalPrefix(pfx string) Option
  • func AdditionalString(str string) Option
  • func OverrideSelfName(self string) Option
  • func ParagraphIndent(indent int) Option
  • func TrailingNewLine() Option
• type ParamDoc

Constants

const (
	CommentsTabWidth = 4
)

Functions

func EnsureInfoFields

func EnsureInfoFields(v interface{}) struct{}

EnsureInfoFields ensures that the given type contains all fields inside InfoFields.

func GoDoc

func GoDoc(v interface{}, indentLvl int, opts ...Option) string

GoDoc renders a Go documentation string from the given struct. The struct should contain at least the field Name, InfoAttrs and InfoElements.

func Synopsis

func Synopsis(v interface{}, indentLvl int, opts ...Option) string

Synopsis renders the synopsis of the documentation.

Types

type InfoFields

type InfoFields struct {
	Name       *string
	Attrs      *gir.InfoAttrs
	Elements   *gir.InfoElements
	ParamDocs  []ParamDoc
	ReturnDocs []ParamDoc
}

InfoFields contains common fields that a GIR schema type may contain. These fields should rarely be used, because they're too magical. All fields inside InfoFields are optional.

func GetInfoFields

func GetInfoFields(v interface{}) InfoFields

GetInfoFields gets the InfoFields from the given value.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option defines possible options for GoDoc.

func AdditionalPrefix

func AdditionalPrefix(pfx string) Option

AdditionalPrefix adds the given prefix string into the head of the comment.

func AdditionalString

func AdditionalString(str string) Option

AdditionalString adds the given string into the tail of the comment as another paragraph.

func OverrideSelfName

func OverrideSelfName(self string) Option

OverrideSelfName overrides the Go type name that's implicitly converted automatically by GoDoc.

func ParagraphIndent

func ParagraphIndent(indent int) Option

ParagraphIndent indents the inner comment paragraphs.

func TrailingNewLine

func TrailingNewLine() Option

TrailingNewLine adds a trailing new line during documentation generation.

type ParamDoc

type ParamDoc struct {
	Name         string
	Optional     bool
	InfoElements gir.InfoElements
}

ParamDoc is the documentation for one parameter. It is added by callable generators for GoDoc to generate the rest.