Skip to content

MbedCRC docs update #8521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 27, 2018
Merged

MbedCRC docs update #8521

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions drivers/MbedCRC.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,7 @@ class MbedCRC {
* This API is used to perform final computation to get correct CRC value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

@maciejbocianski maciejbocianski Oct 24, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@melwee01 What shall be fixed?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 :-(

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But yes. mbed -> Mbed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 !

*
* @param crc CRC result
* @return 0 on success or a negative in case of failure
*/
int32_t compute_partial_stop(uint32_t *crc)
{
Expand Down