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.

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

MbedCRC docs update #8521

Merged
merged 1 commit into from Oct 27, 2018

Conversation

Projects
None yet
6 participants
@maciejbocianski
Member

maciejbocianski commented Oct 24, 2018

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

@0xc0170 0xc0170 requested review from melwee01 and AnotherButler Oct 24, 2018

@0xc0170 0xc0170 requested a review from deepikabhavnani Oct 24, 2018

@@ -258,6 +258,7 @@ class MbedCRC {
* This API is used to perform final computation to get correct CRC value.

This comment has been minimized.

@melwee01

melwee01 Oct 24, 2018

Contributor

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.

This comment has been minimized.

@maciejbocianski

maciejbocianski Oct 24, 2018

Member

You mean the line:

/* mbed Microcontroller Library

But all mbed source use this license header style

This comment has been minimized.

@0xc0170

0xc0170 Oct 24, 2018

Member

@melwee01 What shall be fixed?

This comment has been minimized.

@deepikabhavnani

deepikabhavnani Oct 24, 2018

Contributor

mbed - Mbed
It should be fixed in all the files

/* mbed Microcontroller Library

/* mbed Microcontroller Library

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

This comment has been minimized.

@melwee01

melwee01 Oct 25, 2018

Contributor

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.

This comment has been minimized.

@melwee01

melwee01 Oct 25, 2018

Contributor

But yes. mbed -> Mbed.

This comment has been minimized.

@0xc0170

0xc0170 Oct 25, 2018

Member

@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

This comment has been minimized.

@deepikabhavnani

This comment has been minimized.

Contributor

deepikabhavnani commented Oct 24, 2018

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.

@0xc0170 0xc0170 added needs: CI and removed needs: review labels Oct 25, 2018

@AnotherButler

This comment has been minimized.

Contributor

AnotherButler commented Oct 25, 2018

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

@cmonr cmonr referenced this pull request Oct 26, 2018

Merged

Rollup PR: UK Docathon pt2 #8552

@cmonr

This comment has been minimized.

Contributor

cmonr commented Oct 26, 2018

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.

@cmonr cmonr merged commit 394df12 into ARMmbed:master Oct 27, 2018

11 checks passed

continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
jenkins-ci/cloud-client-test Success
Details
jenkins-ci/unittests Success
Details
travis-ci/astyle Passed, 678 files (+0 files)
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/events Passed, runtime is 9213 cycles (+127 cycles)
Details
travis-ci/gitattributestest Local gitattributestest testing has passed
Details
travis-ci/licence_check Local licence_check testing has passed
Details
travis-ci/littlefs Passed, code size is 8372B (+0.00%)
Details
travis-ci/tools-py2.7 Local tools-py2.7 testing has passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment