sigs.k8s.io/controller-tools@v0.15.1-0.20240515195456-85686cb69316/pkg/genall/zz_generated.markerhelp.go (about)

     1  //go:build !ignore_autogenerated
     2  
     3  /*
     4  Copyright2019 The Kubernetes Authors.
     5  
     6  Licensed under the Apache License, Version 2.0 (the "License");
     7  you may not use this file except in compliance with the License.
     8  You may obtain a copy of the License at
     9  
    10      http://www.apache.org/licenses/LICENSE-2.0
    11  
    12  Unless required by applicable law or agreed to in writing, software
    13  distributed under the License is distributed on an "AS IS" BASIS,
    14  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    15  See the License for the specific language governing permissions and
    16  limitations under the License.
    17  */
    18  
    19  // Code generated by helpgen. DO NOT EDIT.
    20  
    21  package genall
    22  
    23  import (
    24  	"sigs.k8s.io/controller-tools/pkg/markers"
    25  )
    26  
    27  func (InputPaths) Help() *markers.DefinitionHelp {
    28  	return &markers.DefinitionHelp{
    29  		Category: "",
    30  		DetailedHelp: markers.DetailedHelp{
    31  			Summary: "represents paths and go-style path patterns to use as package roots.",
    32  			Details: "Multiple paths can be specified using \"{path1, path2, path3}\".",
    33  		},
    34  		FieldHelp: map[string]markers.DetailedHelp{},
    35  	}
    36  }
    37  
    38  func (OutputArtifacts) Help() *markers.DefinitionHelp {
    39  	return &markers.DefinitionHelp{
    40  		Category: "",
    41  		DetailedHelp: markers.DetailedHelp{
    42  			Summary: "outputs artifacts to different locations, depending on",
    43  			Details: "whether they're package-associated or not.\n\n\nNon-package associated artifacts\nare output to the Config directory, while package-associated ones are output\nto their package's source files' directory, unless an alternate path is\nspecified in Code.",
    44  		},
    45  		FieldHelp: map[string]markers.DetailedHelp{
    46  			"Config": {
    47  				Summary: "points to the directory to which to write configuration.",
    48  				Details: "",
    49  			},
    50  			"Code": {
    51  				Summary: "overrides the directory in which to write new code (defaults to where the existing code lives).",
    52  				Details: "",
    53  			},
    54  		},
    55  	}
    56  }
    57  
    58  func (OutputToDirectory) Help() *markers.DefinitionHelp {
    59  	return &markers.DefinitionHelp{
    60  		Category: "",
    61  		DetailedHelp: markers.DetailedHelp{
    62  			Summary: "outputs each artifact to the given directory, regardless",
    63  			Details: "of if it's package-associated or not.",
    64  		},
    65  		FieldHelp: map[string]markers.DetailedHelp{},
    66  	}
    67  }
    68  
    69  func (outputToNothing) Help() *markers.DefinitionHelp {
    70  	return &markers.DefinitionHelp{
    71  		Category: "",
    72  		DetailedHelp: markers.DetailedHelp{
    73  			Summary: "skips outputting anything.",
    74  			Details: "",
    75  		},
    76  		FieldHelp: map[string]markers.DetailedHelp{},
    77  	}
    78  }
    79  
    80  func (outputToStdout) Help() *markers.DefinitionHelp {
    81  	return &markers.DefinitionHelp{
    82  		Category: "",
    83  		DetailedHelp: markers.DetailedHelp{
    84  			Summary: "outputs everything to standard-out, with no separation.",
    85  			Details: "Generally useful for single-artifact outputs.",
    86  		},
    87  		FieldHelp: map[string]markers.DetailedHelp{},
    88  	}
    89  }