gen

Documentation

Overview

Package gen provides a command to generate documentation for a Go package.

Index

• type Config
• type Gen
  • func New(c Config) *Gen
  • func (g *Gen) Run(cmd *cobra.Command, args []string)

Types

type Config

type Config struct {
	// Title for the documentation, if empty the package name is used.
	Title string `json:"title"`
	// A list of sections to include in the documentation.
	//
	// Available sections:
	// - constants
	// - factories
	// - functions
	// - methods
	// - types
	// - variables
	//
	// if empty all sections are included.
	IncludeSections []string `json:"includeSections"`
	// A list of folders to exclude from the documentation.
	// if empty nothing is excluded.
	ExcludePaths []string `json:"excludePaths"`
	// Read all files in the package and generate the documentation.
	// it can be used in combination with include, and exclude.
	Recursive bool `json:"recursive"`
	// Respect case when matching symbols
	RespectCase bool `json:"respectCase"`
	// One-line representation for each symbol
	Short bool `json:"short"`
	// Print source code for each symbol
	PrintSource bool `json:"printSource"`
	// Include unexported symbols
	Unexported bool `json:"unexported"`
	// SkipSubPackages will omit the sub packages Section from the README.
	SkipSubPkgs bool `json:"skipSubPkgs"`
	// SkipExamples will omit the examples from the README.
	SkipExamples bool `json:"skipExamples"`
}

Config is used to configure the documentation generation.

type Gen

type Gen struct {
	// contains filtered or unexported fields
}

Gen is used to generate documentation for a Go package.

func New

func New(c Config) *Gen

New creates a new Gen instance.

func (*Gen) Run

func (g *Gen) Run(cmd *cobra.Command, args []string)

Run executes the documentation generation process.