Fix docs rake task and cop example comments

[IanMadd]

Description

Mostly this is updating the docs rake task so the @example Yard text is output into the generated YAML files unmodified. I'll update the docs generation layout so the entire example block is a single code block.
That'll fix weirdness like this --> https://docs.chef.io/workstation/cookstyle/cops/chef_deprecations_deprecatedchefspecplatform/
This also allows other comments and formatting that people might put in the example block.

This also matches the RuboCop cops documentation style. E.g. https://docs.rubocop.org/rubocop/cops_bundler.html

Related Issue

• https://progresssoftware.atlassian.net/browse/CHEF-9603

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Chore (non-breaking change that does not add functionality or fix an issue)

Checklist:

• I have read the CONTRIBUTING document.
• I have run the pre-merge tests locally and they pass.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• If Gemfile.lock has changed, I have used --conservative to do it and included the full output in the Description above.
• All new and existing tests passed.
• All commits have been signed-off for the Developer Certificate of Origin.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud