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

Non copyable doc #8509

Merged
merged 6 commits into from Oct 27, 2018

Conversation

Projects
None yet
5 participants
@pan-
Member

pan- commented Oct 23, 2018

Description

Rework of the NonCopyable doc:

  • Rewrite of the class documentation
  • Exclude implementation details from doxygen generation.

Pull request type

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

@pan- pan- requested a review from AnotherButler Oct 23, 2018

@cmonr cmonr requested a review from melwee01 Oct 23, 2018

Copy edit NonCopyable.h
Make minor copy edits, mostly to existing text before this PR.
@AnotherButler

Please address the two comments I left.

* Generator on the other hand should return a pointer to the created object.
*
*
* There is a subtle bug in this code, the function get_connection returns a

This comment has been minimized.

@AnotherButler

AnotherButler Oct 23, 2018

Contributor

Query: Can we make this point by showing a good example instead of showing a bug?

This comment has been minimized.

@pan-

pan- Oct 24, 2018

Member

I added the paragraph Background information to provide explained why this class exist. It requires to explain in details the problem it solves which means showing this bug and the existing - but not very readable - workaround.

I can remove this section if you want.

This comment has been minimized.

@AnotherButler

AnotherButler Oct 25, 2018

Contributor

Let's go ahead and remove this section.

* reference to a Connection which is captured by value instead of reference.
*
* When the reference get_connection returns is copied into connection, the
* vtable and others members defined in Connection are copied, but members defined

This comment has been minimized.

@AnotherButler

AnotherButler Oct 23, 2018

Contributor

Query: Should this be vtable, or is this a typo?

This comment has been minimized.

@pan-

pan- Oct 24, 2018

Member

This is not a typo. In C++ the vtable is the table to the virtual member function of a class.

@cmonr cmonr removed the rollup PR label Oct 24, 2018

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Oct 24, 2018

@AnotherButler New review needed

Comments addressed. Please re-review.

@cmonr cmonr removed the rollup PR label Oct 25, 2018

@melwee01

This comment has been minimized.

Contributor

melwee01 commented Oct 26, 2018

So this isn't part of rollup?

@melwee01

This comment has been minimized.

Contributor

melwee01 commented Oct 26, 2018

I can review here.

@cmonr

This comment has been minimized.

Contributor

cmonr commented Oct 26, 2018

This wasn't part of the rollup at the time, but I should be able to tack it onto the current one.

@cmonr cmonr added the rollup PR label Oct 26, 2018

@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.

If any more commits are made to this PR, this will have to go through CI on it's own.

@cmonr cmonr added needs: CI and removed needs: review labels Oct 26, 2018

@cmonr

cmonr approved these changes Oct 26, 2018

@cmonr cmonr referenced this pull request Oct 26, 2018

Merged

Rollup PR: UK Docathon pt2 #8552

@cmonr cmonr merged commit 47adbd2 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, 537 files (+1 files)
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/events Passed, runtime is 10344 cycles (+1161 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