conversion-gen: add godocs for peer dirs

This commit is contained in:
Dr. Stefan Schimanski 2017-11-30 10:16:49 +01:00
parent 94d2a67263
commit d49bbb9228

View File

@ -33,12 +33,14 @@ var DefaultBasePeerDirs = []string{
// CustomArgs is used by the gengo framework to pass args specific to this generator. // CustomArgs is used by the gengo framework to pass args specific to this generator.
type CustomArgs struct { type CustomArgs struct {
// Base peer dirs which nearly everybody will use, i.e. outside of Kubernetes core. // Base peer dirs which nearly everybody will use, i.e. outside of Kubernetes core. Peer dirs
// are declared to make the generator pick up manually written conversion funcs from external
// packages.
BasePeerDirs []string BasePeerDirs []string
// Custom peer dirs which are application specific. Always consider these as // Custom peer dirs which are application specific. Peer dirs are declared to make the
// last-ditch possibilities for conversions. // generator pick up manually written conversion funcs from external packages.
ExtraPeerDirs []string // ExtraPeerDirs []string
// Skipunsafe indicates whether to generate unsafe conversions to improve the efficiency // Skipunsafe indicates whether to generate unsafe conversions to improve the efficiency
// of these operations. The unsafe operation is a direct pointer assignment via unsafe // of these operations. The unsafe operation is a direct pointer assignment via unsafe