Skip to content

Non copyable doc #8509

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

Merged
merged 6 commits into from
Oct 27, 2018
Merged

Non copyable doc #8509

merged 6 commits into from
Oct 27, 2018

Conversation

pan-
Copy link
Member

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

Make minor copy edits, mostly to existing text before this PR.
Copy link
Contributor

@AnotherButler AnotherButler left a comment

Choose a reason for hiding this comment

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

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
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Member Author

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

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
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Member Author

Choose a reason for hiding this comment

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

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
Copy link
Contributor

0xc0170 commented Oct 24, 2018

@AnotherButler New review needed

@cmonr cmonr dismissed AnotherButler’s stale review October 25, 2018 00:22

Comments addressed. Please re-review.

@cmonr cmonr removed the rollup PR label Oct 25, 2018
@melwee01
Copy link
Contributor

So this isn't part of rollup?

@melwee01
Copy link
Contributor

I can review here.

@cmonr
Copy link
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
Copy link
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 merged commit 47adbd2 into ARMmbed:master Oct 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants