🐛 crd: Respect multiline comments at godocs

[qinqon]

Sometimes at type has examples about how to use it embedding something like a yaml on it, yamls should not be truncated and they are white space sensitive. This change keep the new lines and also remove the white space trimming only on /* comments.

Golang struct example with problematic comment.

// DnsState  DNS resolver state. Example partial yaml output of [NetworkState] with
// static DNS config:                                                           
// ```yaml                                                                      
// ---                                                                          
// dns-resolver:                                                                
//                                                                              
//  running:                                                                    
//     server:                                                                  
//     - 2001:db8:1::250                                                        
//     - 192.0.2.250                                                            
//     search:                                                                  
//     - example.org                                                            
//     - example.net                                                            
//  config:                                                                     
//     search:                                                                  
//     - example.org                                                            
//     - example.net                                                            
//     server:                                                                  
//     - 2001:db8:1::250                                                        
//     - 192.0.2.250                                                            
//     options:                                                                 
//     - trust-ad                                                               
//     - rotate                                                                 
//                                                                              
// ```                                                                          
// To purge all static DNS configuration:                                       
// ```yml                                                                       
// ---                                                                          
// dns-resolver:                                                                
//                                                                              
//  config: {}                                                                  
//                                                                              
// ```                                                                          
// +k8s:deepcopy-gen=true                                                       
type DnsState struct {                                                          
...
}

Part of the probem was introduced at #517

[qinqon]

/cc @varshaprasad96

[varshaprasad96]

This change looks good to me, but it would break a lot of existing docs. @qinqon Some of the integration tests are failing due to formating changes, could you please fix them? (https://prow.k8s.io/view/gs/kubernetes-jenkins/pr-logs/pull/kubernetes-sigs_controller-tools/870/pull-controller-tools-test-master/1737421873815228416#)

cc: @alvaroaleman any thoughts on this? Making this change optional may be an overkill. Having this introduced in a new release is still fine?

[qinqon]

This change looks good to me, but it would break a lot of existing docs. @qinqon Some of the integration tests are failing due to formating changes, could you please fix them? (https://prow.k8s.io/view/gs/kubernetes-jenkins/pr-logs/pull/kubernetes-sigs_controller-tools/870/pull-controller-tools-test-master/1737421873815228416#)

cc: @alvaroaleman any thoughts on this? Making this change optional may be an overkill. Having this introduced in a new release is still fine?

Ok, let me fix stuff.

[qinqon]

@varshaprasad96 @alvaroaleman test fixed, I have regenerate all the testing CRDs impacted so you can check how "description" field looks now.

[varshaprasad96]

/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alvaroaleman, qinqon, varshaprasad96

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [alvaroaleman]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment