2023-03-05 19:28:31 -07:00
|
|
|
// Copyright 2013-2023 The Cobra Authors
|
2022-09-16 04:55:56 -07:00
|
|
|
//
|
|
|
|
// 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.
|
|
|
|
|
2015-11-23 16:19:16 -07:00
|
|
|
package doc_test
|
2015-09-08 13:02:02 -07:00
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
|
|
|
"fmt"
|
|
|
|
|
|
|
|
"github.com/spf13/cobra"
|
2015-11-23 16:19:16 -07:00
|
|
|
"github.com/spf13/cobra/doc"
|
2015-09-08 13:02:02 -07:00
|
|
|
)
|
|
|
|
|
2017-04-01 13:45:39 -07:00
|
|
|
func ExampleGenManTree() {
|
2015-09-08 13:02:02 -07:00
|
|
|
cmd := &cobra.Command{
|
|
|
|
Use: "test",
|
|
|
|
Short: "my test program",
|
|
|
|
}
|
2015-11-23 16:19:16 -07:00
|
|
|
header := &doc.GenManHeader{
|
2015-09-08 13:02:02 -07:00
|
|
|
Title: "MINE",
|
|
|
|
Section: "3",
|
|
|
|
}
|
2021-02-07 17:08:50 -07:00
|
|
|
cobra.CheckErr(doc.GenManTree(cmd, header, "/tmp"))
|
2015-09-08 13:02:02 -07:00
|
|
|
}
|
|
|
|
|
2017-04-01 13:45:39 -07:00
|
|
|
func ExampleGenMan() {
|
2015-09-08 13:02:02 -07:00
|
|
|
cmd := &cobra.Command{
|
|
|
|
Use: "test",
|
|
|
|
Short: "my test program",
|
|
|
|
}
|
2015-11-23 16:19:16 -07:00
|
|
|
header := &doc.GenManHeader{
|
2015-09-08 13:02:02 -07:00
|
|
|
Title: "MINE",
|
|
|
|
Section: "3",
|
|
|
|
}
|
|
|
|
out := new(bytes.Buffer)
|
2021-02-07 17:08:50 -07:00
|
|
|
cobra.CheckErr(doc.GenMan(cmd, header, out))
|
2015-09-08 13:02:02 -07:00
|
|
|
fmt.Print(out.String())
|
|
|
|
}
|