# Functions
NewEncoder initializes and returns an `Encoder`.
WithComments enables comments and examples in the encoder.
# Constants
CommentsAll renders all comments.
CommentsDisabled renders no comments.
CommentsDocs enables rendering each config field short docstring.
CommentsExamples enables commented yaml examples rendering.
FootComment populates `yaml.Node` `FootComment`.
HeadComment populates `yaml.Node` `HeadComment`.
LineComment populates `yaml.Node` `LineComment`.
# Structs
Appearance of a type in a different type.
Doc represents a struct documentation rendered from comments by docgen.
Encoder implements config encoder.
Example represents one example snippet for a type.
FileDoc represents a single go file documentation.
No description provided by the author
Options defines encoder config.
# Interfaces
Documented is used to check if struct has any documentation defined for it.
# Type aliases
CommentsFlags comments encoding flags type.
Option gives ability to alter config encoder output settings.