docs

Documentation

Overview

This file was originally part of cobra/doc and has the following license:

Copyright 2016 French Ben. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func GenYaml(cmd *cobra.Command, w io.Writer) error
• func GenYamlCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error
• func GenYamlTree(cmd *cobra.Command, dir string) error
• func GenYamlTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error

Functions

func GenYaml

func GenYaml(cmd *cobra.Command, w io.Writer) error

GenYaml creates yaml output.

func GenYamlCustom

func GenYamlCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error

GenYamlCustom creates custom yaml output.

func GenYamlTree

func GenYamlTree(cmd *cobra.Command, dir string) error

GenYamlTree creates yaml structured ref files for this command and all descendants in the directory given. This function may not work correctly if your command names have `-` in them. If you have `cmd` with two subcmds, `sub` and `sub-third`, and `sub` has a subcommand called `third` it is undefined which help output will be in the file `cmd-sub-third.1`.

func GenYamlTreeCustom

func GenYamlTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error

GenYamlTreeCustom creates yaml structured ref files.