Skip to content

Correct Platform::Guid constructor and operators - #716

Merged
Colin Robertson (colin-home) merged 2 commits into
MicrosoftDocs:masterfrom
oldnewthing:patch-1
Jan 15, 2019
Merged

Colin Robertson (colin-home) merged 2 commits into
MicrosoftDocs:masterfrom
oldnewthing:patch-1

Conversation

@oldnewthing

Copy link
Copy Markdown
Contributor
  • Fix documentation for the m parameter to the Platform::Guid single-parameter constructor.
  • Fix typos in the documentation for the operator== and operator!= operators.
  • Add documentation for missing operator< operator, including caveats.
  • Fix garbled documentation for the operator() operator.
  • Fix broken link to operator!= and broken link to "How to generate a GUID?"

* Fix documentation for the `m` parameter to the `Platform::Guid` single-parameter constructor.
* Fix typos in the documentation for the `operator==` and `operator!=` operators.
* Add documentation for missing `operator<` operator, including caveats.
* Fix garbled documentation for the `operator()` operator.
* Fix broken link to `operator!=` and broken link to "How to generate a GUID?"
@PRMerger8

Copy link
Copy Markdown
Contributor

Raymond Chen (@oldnewthing) : Thanks for your contribution! The author, @, has been notified to review your proposed change.

### Remarks

For an example of how to generate a new Platform::Guid using the Windows function [CoCreateGuid](/windows/desktop/api/combaseapi/nf-combaseapi-cocreateguid), see [WinRT component: How to generate a GUID?](http://blogs.msdn.com/b/eternalcoding/archive/2013/03/25/winrt-component-how-to-generate-a-guid.aspx)
For an example of how to generate a new Platform::Guid using the Windows function [CoCreateGuid](/windows/desktop/api/combaseapi/nf-combaseapi-cocreateguid), see [WinRT component: How to generate a GUID?](https://www.eternalcoding.com/?p=383)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Consider also linking to https://docs.microsoft.com/en-us/uwp/api/windows.foundation.guidhelper, which was created for JS, but is useful anywhere. Also may be worth calling out prefer Platform::GUID compare over GuidHelper::Equals in CX.

@GitHubber17

Copy link
Copy Markdown
Contributor

Raymond Chen (@oldnewthing) Ben Kuhn (@BenJKuhn) - Microsoft authors and contributors need to make content contributions through the private repository so the content can be staged and validated by the current validation rules. Read about authors working in the public repo for more information.

In the private repo, after you review the content on staging and fix any validation issues, you can add the sign-off comment to let PR reviewers know that the updates are ready to be merged.

If you need help getting set up to work in the private repo, see Set up Git repository locally for documentation.

As a courtesy, we'll pull these commits to the private repo for you, so we can verify the content on staging. We'll post a new PR # shortly and then close this PR.

Thanks

@colin-home

Copy link
Copy Markdown
Contributor

Beth Harvey (@GitHubber17) The guidance on authors working in the public repo has a specific exemption: "Microsoft employees from other teams can work in public repos at this time to ensure their contributions are reviewed by the article author." Basically, that's a pass for anyone who isn't @corob-msft or Mike B (@mikeblome), since we're the only authors in this repo. Everything merged into the public repo is then moved to the private repo for build verification by automation, and it must pass there before it goes live. This doesn't need to be done manually.

Switch open angle brackets to entities.
Update the date.
@PRMerger14

Copy link
Copy Markdown
Contributor

@corob-msft : Thanks for your contribution! The author, @, has been notified to review your proposed change.

@colin-home
Colin Robertson (colin-home) merged commit a883df9 into MicrosoftDocs:master Jan 15, 2019
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.

6 participants