gensnippets

Documentation

Overview

Package gensnippets processes GoDoc examples.

Index

• func Generate(rootDir, outDir string, apiShortnames map[string]string) error
• func GenerateSnippetsDirs(rootDir, outDir string, apiShortNames map[string]string, dirs []string) error

Functions

func Generate

func Generate(rootDir, outDir string, apiShortnames map[string]string) error

Generate reads all modules in rootDir and outputs their examples in outDir.

func GenerateSnippetsDirs

func GenerateSnippetsDirs(rootDir, outDir string, apiShortNames map[string]string, dirs []string) error

GenerateSnippetsDirs takes in specified modules in rootDir and outputs their examples in outDir. If a single directory is passed in that is the root directory, all modules will be run.