doc

type Config struct {
	// The title for the API doc; e.g. "FooBar API v3"
	Title string

	// The path to the file to which the output should be written, if the
	// file doesn't exist it will be created, if it exists it will be truncated.
	ResultDest string // required

	// AssetsPath should be set to the folder that contains the asset files.
	AssetsPath string // required

	// AssetsDest can optionally be set to the location to which the default
	// assets, the contents of this package's /assets folder, should be copied.
	// If AssetsDest is left unset the user will need to copy the assets manually.
	AssetsDest string

	// The host which will be used in example snippets. If no host
	// is provided it will default to the value of DefaultExampleHost.
	ExampleHost string

	// The tag key to be used to retrieve a field's name, defaults
	// to "json". If no name is present in the tag value associated with
	// the key, the field's name will be used as fallback.
	FieldNameTagKey string

	// CustomTypeName allows you to customise a field's type name that is
	// displayed next to that field's name. For example you could display
	// `bigint` instead of `int64`, `object` instead of `map`, etc.
	// If no func is provided or it returns false as the second return
	// value (ok) it will fall back to the default behaviour.
	CustomTypeName func(reflect.Type) (label string, ok bool)

	// HideTestStatus allows for hiding of the test status that
	// is by default displayed next to each endpoint.
	HideTestStatus bool

	// Styles is an optional list of custom CSS files. If not empty the styles
	// will be added after the default styles to effectively overwrite them.
	Styles []string
}

type ConstTable struct {
	Name string
	Type interface{}
}

type TOC []*TopicList

type Topic struct {
	Name string
	Desc string

	// Type can be used to set the topic's "main" type. If Type is set to a
	// non-nil value, that value's type information will be rendered at the
	// top of the topic. This can be useful if the topic's const tables and
	// hit endpoints all relate to one type, setting Type to a value of that
	// type will render the type's information above the tables and endpoints.
	Type interface{}

	Tables []*ConstTable
	Epts   []*hit.Test
	File   string
}

type TopicList struct {
	Heading string
	List    []*Topic
}