Fix godoc manually by simply replacing existing comments

Author: tsuzu

api/v1beta1/cluster_types.go

@@ -466,7 +466,7 @@ type ClusterSpec struct {
 	// +optional
 	Paused bool `json:"paused,omitempty"`
 
-	// Cluster network configuration.
+	// clusterNetwork represents the cluster network configuration.
 	// +optional
 	ClusterNetwork *ClusterNetwork `json:"clusterNetwork,omitempty"`
 
@@ -515,7 +515,7 @@ type ClusterAvailabilityGate struct {
 
 // Topology encapsulates the information of the managed resources.
 type Topology struct {
-	// The name of the ClusterClass object to create the topology.
+	// class is the name of the ClusterClass object to create the topology.
 	Class string `json:"class"`
 
 	// classNamespace is the namespace of the ClusterClass object to create the topology.
@@ -527,7 +527,7 @@ type Topology struct {
 	// +kubebuilder:validation:Pattern=`^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?(?:\.[a-z0-9](?:[-a-z0-9]*[a-z0-9])?)*$`
 	ClassNamespace string `json:"classNamespace,omitempty"`
 
-	// The Kubernetes version of the cluster.
+	// version is the Kubernetes version of the cluster.
 	Version string `json:"version"`
 
 	// rolloutAfter performs a rollout of the entire cluster one component at a time,
@@ -667,14 +667,14 @@ type MachineDeploymentTopology struct {
 	// +optional
 	NodeDeletionTimeout *metav1.Duration `json:"nodeDeletionTimeout,omitempty"`
 
-	// Minimum number of seconds for which a newly created machine should
+	// minReadySeconds is the minimum number of seconds for which a newly created machine should
 	// be ready.
 	// Defaults to 0 (machine will be considered available as soon as it
 	// is ready)
 	// +optional
 	MinReadySeconds *int32 `json:"minReadySeconds,omitempty"`
 
-	// The deployment strategy to use to replace existing machines with
+	// strategy is the deployment strategy to use to replace existing machines with
 	// new ones.
 	// +optional
 	Strategy *MachineDeploymentStrategy `json:"strategy,omitempty"`
@@ -744,7 +744,7 @@ type MachinePoolTopology struct {
 	// +optional
 	NodeDeletionTimeout *metav1.Duration `json:"nodeDeletionTimeout,omitempty"`
 
-	// Minimum number of seconds for which a newly created machine pool should
+	// minReadySeconds is the minimum number of seconds for which a newly created machine pool should
 	// be ready.
 	// Defaults to 0 (machine will be considered available as soon as it
 	// is ready)
@@ -825,15 +825,15 @@ type ClusterNetwork struct {
 	// +optional
 	APIServerPort *int32 `json:"apiServerPort,omitempty"`
 
-	// The network ranges from which service VIPs are allocated.
+	// services is the network ranges from which service VIPs are allocated.
 	// +optional
 	Services *NetworkRanges `json:"services,omitempty"`
 
-	// The network ranges from which Pod networks are allocated.
+	// pods is the network ranges from which Pod networks are allocated.
 	// +optional
 	Pods *NetworkRanges `json:"pods,omitempty"`
 
-	// Domain name for services.
+	// serviceDomain is the domain name for services.
 	// +optional
 	ServiceDomain string `json:"serviceDomain,omitempty"`
 }
@@ -1008,10 +1008,10 @@ func (c *ClusterStatus) GetTypedPhase() ClusterPhase {
 
 // APIEndpoint represents a reachable Kubernetes API endpoint.
 type APIEndpoint struct {
-	// The hostname on which the API server is serving.
+	// host is the hostname on which the API server is serving.
 	Host string `json:"host"`
 
-	// The port on which the API server is serving.
+	// port is the port on which the API server is serving.
 	Port int32 `json:"port"`
 }
 

api/v1beta1/clusterclass_types.go

@@ -243,14 +243,14 @@ type MachineDeploymentClass struct {
 	// +optional
 	NodeDeletionTimeout *metav1.Duration `json:"nodeDeletionTimeout,omitempty"`
 
-	// Minimum number of seconds for which a newly created machine should
+	// minReadySeconds is the minimum number of seconds for which a newly created machine should
 	// be ready.
 	// Defaults to 0 (machine will be considered available as soon as it
 	// is ready)
 	// NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.
 	MinReadySeconds *int32 `json:"minReadySeconds,omitempty"`
 
-	// The deployment strategy to use to replace existing machines with
+	// strategy is the deployment strategy to use to replace existing machines with
 	// new ones.
 	// NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.
 	Strategy *MachineDeploymentStrategy `json:"strategy,omitempty"`
@@ -377,7 +377,7 @@ type MachinePoolClass struct {
 	// +optional
 	NodeDeletionTimeout *metav1.Duration `json:"nodeDeletionTimeout,omitempty"`
 
-	// Minimum number of seconds for which a newly created machine pool should
+	// minReadySeconds is the minimum number of seconds for which a newly created machine pool should
 	// be ready.
 	// Defaults to 0 (machine will be considered available as soon as it
 	// is ready)
@@ -452,7 +452,7 @@ type ClusterClassVariable struct {
 //
 // Deprecated: This struct is deprecated and is going to be removed in the next apiVersion.
 type ClusterClassVariableMetadata struct {
-	// Map of string keys and values that can be used to organize and categorize
+	// labels is a map of string keys and values that can be used to organize and categorize
 	// (scope and select) variables.
 	// +optional
 	Labels map[string]string `json:"labels,omitempty"`
@@ -673,7 +673,7 @@ type JSONSchemaProps struct {
 // VariableSchemaMetadata is the metadata of a variable or a nested field within a variable.
 // It can be used to add additional data for higher level tools.
 type VariableSchemaMetadata struct {
-	// Map of string keys and values that can be used to organize and categorize
+	// labels is a map of string keys and values that can be used to organize and categorize
 	// (scope and select) variables.
 	// +optional
 	Labels map[string]string `json:"labels,omitempty"`

api/v1beta1/common_types.go

@@ -273,10 +273,10 @@ const (
 
 // MachineAddress contains information for the node's address.
 type MachineAddress struct {
-	// Machine address type, one of Hostname, ExternalIP, InternalIP, ExternalDNS or InternalDNS.
+	// type is the machine address type, one of Hostname, ExternalIP, InternalIP, ExternalDNS or InternalDNS.
 	Type MachineAddressType `json:"type"`
 
-	// The machine address.
+	// address is the machine address.
 	Address string `json:"address"`
 }
 
@@ -305,7 +305,7 @@ type MachineAddresses []MachineAddress
 // In future versions, controller-tools@v2 might allow overriding the type and validation for embedded
 // types. When that happens, this hack should be revisited.
 type ObjectMeta struct {
-	// Map of string keys and values that can be used to organize and categorize
+	// labels is a map of string keys and values that can be used to organize and categorize
 	// (scope and select) objects. May match selectors of replication controllers
 	// and services.
 	// More info: http://kubernetes.io/docs/user-guide/labels

api/v1beta1/condition_types.go

@@ -67,18 +67,18 @@ type Condition struct {
 	// +optional
 	Severity ConditionSeverity `json:"severity,omitempty"`
 
-	// Last time the condition transitioned from one status to another.
+	// lastTransitionTime is the last time the condition transitioned from one status to another.
 	// This should be when the underlying condition changed. If that is not known, then using the time when
 	// the API field changed is acceptable.
 	LastTransitionTime metav1.Time `json:"lastTransitionTime"`
 
-	// The reason for the condition's last transition in CamelCase.
+	// reason is the reason for the condition's last transition in CamelCase.
 	// The specific API may choose whether or not this field is considered a guaranteed API.
 	// This field may be empty.
 	// +optional
 	Reason string `json:"reason,omitempty"`
 
-	// A human readable message indicating details about the transition.
+	// message is a human readable message indicating details about the transition.
 	// This field may be empty.
 	// +optional
 	Message string `json:"message,omitempty"`

api/v1beta1/machinedeployment_types.go

@@ -244,7 +244,7 @@ type MachineDeploymentSpec struct {
 	// +kubebuilder:validation:MinLength=1
 	ClusterName string `json:"clusterName"`
 
-	// Number of desired machines.
+	// replicas is the number of desired machines.
 	// This is a pointer to distinguish between explicit zero and not specified.
 	//
 	// Defaults to:
@@ -273,15 +273,15 @@ type MachineDeploymentSpec struct {
 	// +optional
 	RolloutAfter *metav1.Time `json:"rolloutAfter,omitempty"`
 
-	// Label selector for machines. Existing MachineSets whose machines are
+	// selector is the label selector for machines. Existing MachineSets whose machines are
 	// selected by this will be the ones affected by this deployment.
 	// It must match the machine template's labels.
 	Selector metav1.LabelSelector `json:"selector"`
 
 	// template describes the machines that will be created.
 	Template MachineTemplateSpec `json:"template"`
 
-	// The deployment strategy to use to replace existing machines with
+	// strategy is the deployment strategy to use to replace existing machines with
 	// new ones.
 	// +optional
 	Strategy *MachineDeploymentStrategy `json:"strategy,omitempty"`
@@ -296,7 +296,7 @@ type MachineDeploymentSpec struct {
 	// +optional
 	MinReadySeconds *int32 `json:"minReadySeconds,omitempty"`
 
-	// The number of old MachineSets to retain to allow rollback.
+	// revisionHistoryLimit is the number of old MachineSets to retain to allow rollback.
 	// This is a pointer to distinguish between explicit zero and not specified.
 	// Defaults to 1.
 	//
@@ -305,11 +305,11 @@ type MachineDeploymentSpec struct {
 	// +optional
 	RevisionHistoryLimit *int32 `json:"revisionHistoryLimit,omitempty"`
 
-	// Indicates that the deployment is paused.
+	// paused indicates that the deployment is paused.
 	// +optional
 	Paused bool `json:"paused,omitempty"`
 
-	// The maximum time in seconds for a deployment to make progress before it
+	// progressDeadlineSeconds is the maximum time in seconds for a deployment to make progress before it
 	// is considered to be failed. The deployment controller will continue to
 	// process failed deployments and a condition with a ProgressDeadlineExceeded
 	// reason will be surfaced in the deployment status. Note that progress will
@@ -334,7 +334,7 @@ type MachineDeploymentStrategy struct {
 	// +optional
 	Type MachineDeploymentStrategyType `json:"type,omitempty"`
 
-	// Rolling update config params. Present only if
+	// rollingUpdate is the rolling update config params. Present only if
 	// MachineDeploymentStrategyType = RollingUpdate.
 	// +optional
 	RollingUpdate *MachineRollingUpdateDeployment `json:"rollingUpdate,omitempty"`
@@ -351,7 +351,7 @@ type MachineDeploymentStrategy struct {
 
 // MachineRollingUpdateDeployment is used to control the desired behavior of rolling update.
 type MachineRollingUpdateDeployment struct {
-	// The maximum number of machines that can be unavailable during the update.
+	// maxUnavailable is the maximum number of machines that can be unavailable during the update.
 	// Value can be an absolute number (ex: 5) or a percentage of desired
 	// machines (ex: 10%).
 	// Absolute number is calculated from percentage by rounding down.
@@ -366,7 +366,7 @@ type MachineRollingUpdateDeployment struct {
 	// +optional
 	MaxUnavailable *intstr.IntOrString `json:"maxUnavailable,omitempty"`
 
-	// The maximum number of machines that can be scheduled above the
+	// maxSurge is the maximum number of machines that can be scheduled above the
 	// desired number of machines.
 	// Value can be an absolute number (ex: 5) or a percentage of
 	// desired machines (ex: 10%).
@@ -446,7 +446,7 @@ type MachineNamingStrategy struct {
 
 // MachineDeploymentStatus defines the observed state of MachineDeployment.
 type MachineDeploymentStatus struct {
-	// The generation observed by the deployment controller.
+	// observedGeneration is the generation observed by the deployment controller.
 	// +optional
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
@@ -456,26 +456,26 @@ type MachineDeploymentStatus struct {
 	// +optional
 	Selector string `json:"selector,omitempty"`
 
-	// Total number of non-terminated machines targeted by this deployment
+	// replicas is the total number of non-terminated machines targeted by this deployment
 	// (their labels match the selector).
 	// +optional
 	Replicas int32 `json:"replicas"`
 
-	// Total number of non-terminated machines targeted by this deployment
+	// updatedReplicas is the total number of non-terminated machines targeted by this deployment
 	// that have the desired template spec.
 	// +optional
 	UpdatedReplicas int32 `json:"updatedReplicas"`
 
-	// Total number of ready machines targeted by this deployment.
+	// readyReplicas is the total number of ready machines targeted by this deployment.
 	// +optional
 	ReadyReplicas int32 `json:"readyReplicas"`
 
-	// Total number of available machines (ready for at least minReadySeconds)
+	// availableReplicas is the total number of available machines (ready for at least minReadySeconds)
 	// targeted by this deployment.
 	// +optional
 	AvailableReplicas int32 `json:"availableReplicas"`
 
-	// Total number of unavailable machines targeted by this deployment.
+	// unavailableReplicas is the total number of unavailable machines targeted by this deployment.
 	// This is the total number of machines that are still required for
 	// the deployment to have 100% available capacity. They may either
 	// be machines that are running but not yet available or machines

api/v1beta1/machinehealthcheck_types.go

@@ -55,7 +55,7 @@ type MachineHealthCheckSpec struct {
 	// +kubebuilder:validation:MinLength=1
 	ClusterName string `json:"clusterName"`
 
-	// Label selector to match machines whose health will be exercised
+	// selector is a label selector to match machines whose health will be exercised
 	Selector metav1.LabelSelector `json:"selector"`
 
 	// unhealthyConditions contains a list of the conditions that determine
@@ -135,12 +135,12 @@ type UnhealthyCondition struct {
 
 // MachineHealthCheckStatus defines the observed state of MachineHealthCheck.
 type MachineHealthCheckStatus struct {
-	// total number of machines counted by this machine health check
+	// expectedMachines is the total number of machines counted by this machine health check
 	// +kubebuilder:validation:Minimum=0
 	// +optional
 	ExpectedMachines int32 `json:"expectedMachines"`
 
-	// total number of healthy machines counted by this machine health check
+	// currentHealthy is the total number of healthy machines counted by this machine health check
 	// +kubebuilder:validation:Minimum=0
 	// +optional
 	CurrentHealthy int32 `json:"currentHealthy"`
@@ -197,10 +197,10 @@ type MachineHealthCheck struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	// Specification of machine health check policy
+	// spec is the specification of machine health check policy
 	Spec MachineHealthCheckSpec `json:"spec,omitempty"`
 
-	// Most recently observed status of MachineHealthCheck resource
+	// status is the most recently observed status of MachineHealthCheck resource
 	Status MachineHealthCheckStatus `json:"status,omitempty"`
 }
 

api/v1beta1/machineset_types.go

@@ -241,7 +241,7 @@ type MachineTemplateSpec struct {
 	// +optional
 	ObjectMeta `json:"metadata,omitempty"`
 
-	// Specification of the desired behavior of the machine.
+	// spec is the specification of the desired behavior of the machine.
 	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
 	// +optional
 	Spec MachineSpec `json:"spec,omitempty"`
@@ -290,18 +290,18 @@ type MachineSetStatus struct {
 	// +optional
 	Replicas int32 `json:"replicas"`
 
-	// The number of replicas that have labels matching the labels of the machine template of the MachineSet.
+	// fullyLabeledReplicas is the number of replicas that have labels matching the labels of the machine template of the MachineSet.
 	//
 	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
 	//
 	// +optional
 	FullyLabeledReplicas int32 `json:"fullyLabeledReplicas"`
 
-	// The number of ready replicas for this MachineSet. A machine is considered ready when the node has been created and is "Ready".
+	// readyReplicas is the number of ready replicas for this MachineSet. A machine is considered ready when the node has been created and is "Ready".
 	// +optional
 	ReadyReplicas int32 `json:"readyReplicas"`
 
-	// The number of available replicas (ready for at least minReadySeconds) for this MachineSet.
+	// availableReplicas is the number of available replicas (ready for at least minReadySeconds) for this MachineSet.
 	// +optional
 	AvailableReplicas int32 `json:"availableReplicas"`