MbedCRC docs update

[maciejbocianski]

Description

Minor docs update for the MbedCRC class

@deepikabhavnani can you confirm that single doxygen for both constructors and no doxygen for destructor was intentional?

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[X] Docs update
[ ] Test update
[ ] Breaking change

[melwee01]

Note: Mbed is styled incorrectly in license info at top of page. It's not within the set of changes for this commit, so I can't attach this to the correct line.

[maciejbocianski]

You mean the line:

mbed-os/drivers/MbedCRC.h

Line 1 in 5b25b66

/* mbed Microcontroller Library

But all mbed source use this license header style

[0xc0170]

@melwee01 What shall be fixed?

[deepikabhavnani]

mbed - Mbed
It should be fixed in all the files

mbed-os/drivers/AnalogIn.h

Line 1 in 5b25b66

/* mbed Microcontroller Library

mbed-os/drivers/BusIn.h

Line 1 in 5b25b66

/* mbed Microcontroller Library

@0xc0170 - We don't have consistent one license header across all files in repo :-(

[melwee01]

Yeah. I keep getting errors when building doxy files because of license headers in a couple files. They're not files that are part of any PR.

[melwee01]

But yes. mbed -> Mbed.

[0xc0170]

@0xc0170 - We don't have consistent one license header across all files in repo :-(

Definitely. I'll add it to the docs to start the unification

[0xc0170]

https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/reference/contributing/guidelines/license.md#how-to-apply-apache-20-correctly

Already there, just need to do a clean-up one day !

[deepikabhavnani]

can you confirm that single doxygen for both constructors and no doxygen for destructor was intentional?

I guess that was for consistency, all the drivers have single doxygen for constructor/destructor, and mainly for empty destructors.

[AnotherButler]

Note: @oliverjharper is talking with legal about changing old license text.

[cmonr]

Note: This PR is now a part of a rollup PR (#8552).

No further work is needed here, as once that PR is merged, this PR will also be closed and marked as merged.