Improve the annotations of some structs in pkg/api

[IsaacHe20]

Fixed some annotations that violated the golang struct annotation specification.

[vmwclabot]

@heshengyuan1311, you must sign our contributor license agreement before your changes are merged. Click here to sign the agreement. If you are a VMware employee, read this for further instruction.

[vmwclabot]

@heshengyuan1311, your company's legal contact has approved your signed contributor license agreement. It will also be reviewed by VMware, but the merge can proceed.

[tnqn]

Thanks @heshengyuan1311. Do you happen to have the link of "golang struct annotation specification" about this so we can reference to it when reviewing similar changes?

[codecov-commenter]

Codecov Report

Merging #2164 (c5be5a1) into main (03fe6ee) will decrease coverage by 19.86%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##             main    #2164       +/-   ##
===========================================
- Coverage   61.20%   41.33%   -19.87%     
===========================================
  Files         270      132      -138     
  Lines       20478    16539     -3939     
===========================================
- Hits        12533     6837     -5696     
- Misses       6646     9115     +2469     
+ Partials     1299      587      -712     

Flag	Coverage Δ
kind-e2e-tests	?
unit-tests	41.33% <ø> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
pkg/agent/agent_linux.go	0.00% <0.00%> (-100.00%)	⬇️
pkg/ovs/openflow/default.go	0.00% <0.00%> (-100.00%)	⬇️
pkg/agent/config/node_config.go	0.00% <0.00%> (-100.00%)	⬇️
pkg/apis/controlplane/helper.go	0.00% <0.00%> (-100.00%)	⬇️
pkg/agent/cniserver/pod_configuration_linux.go	0.00% <0.00%> (-100.00%)	⬇️
pkg/apis/controlplane/v1beta1/register.go	0.00% <0.00%> (-92.86%)	⬇️
pkg/ovs/openflow/logs.go	9.52% <0.00%> (-90.48%)	⬇️
pkg/apis/controlplane/register.go	0.00% <0.00%> (-90.00%)	⬇️
pkg/agent/nodeportlocal/k8s/annotations.go	0.00% <0.00%> (-83.88%)	⬇️
pkg/agent/client.go	0.00% <0.00%> (-77.42%)	⬇️
... and 226 more

[IsaacHe20]

Thanks @heshengyuan1311. Do you happen to have the link of "golang struct annotation specification" about this so we can reference to it when reviewing similar changes?

Thanks for reviewing. I fix these annotations beacuse of the rule of godoc. https://blog.golang.org/godoc

[antoninbas]

LGTM. I confirmed that the current documentation doesn't render properly because of the missing empty lines. I have also confirmed that K8s always leaves an empty line between code generation directive and actual type comments.

[antoninbas]

/skip-all

[antoninbas]

@heshengyuan1311 CI is failing with the following error:

=== Start resetting changes introduced by YEAR ===
=== pkg/controller/networkpolicy/testing/mock_networkpolicy.go is reset ===
=== pkg/apis/system/v1beta1/zz_generated.deepcopy.go is reset ===
=== pkg/agent/cniserver/ipam/testing/mock_ipam.go is reset ===
The generated code is not up-to-date
You can regenerate it with 'make codegen' and commit the changes
Error: Process completed with exit code 1.

Can you run make codegen and commit the changes?

[IsaacHe20]

Thanks @heshengyuan1311. Do you happen to have the link of "golang struct annotation specification" about this so we can reference to it when reviewing similar changes?

Thanks for reviewing,

@heshengyuan1311 CI is failing with the following error:

=== Start resetting changes introduced by YEAR ===
=== pkg/controller/networkpolicy/testing/mock_networkpolicy.go is reset ===
=== pkg/apis/system/v1beta1/zz_generated.deepcopy.go is reset ===
=== pkg/agent/cniserver/ipam/testing/mock_ipam.go is reset ===
The generated code is not up-to-date
You can regenerate it with 'make codegen' and commit the changes
Error: Process completed with exit code 1.

Can you run make codegen and commit the changes?

repushed the commit with codegen.

[antoninbas]

/skip-all

[antoninbas]

Thanks for regenerating the code - let's see if the CI job succeeds

[tnqn]

LGTM

[vmwclabot]

@heshengyuan1311, VMware has approved your signed contributor license agreement.