Skip to content
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

Fix broken links documentation #619

Merged
merged 5 commits into from Dec 7, 2020
Merged

Conversation

j0shuams
Copy link
Contributor

@j0shuams j0shuams commented Dec 4, 2020

After the codebase restructure, a couple links in the interop.md got broken. I believe I pointed them to where they were originally pointing to. @Scottj1s can you confirm these links are going to the right examples?

Going to comb through the rest of our docs and fix any others I see.

@j0shuams j0shuams changed the title Fix links in interop md Fix broken links documentation Dec 4, 2020
docs/interop.md Outdated
@@ -98,7 +98,7 @@ SetString(MarshalString.GetAbi(marshalStr));
**Note:** The CLR still supports marshaling COM (IUnknown), but not WinRT (IInspectable), interop interfaces. There are two approaches to marshaling IInspectable interfaces in C#/WinRT.

##### Projected
If possible, the interop interface should be defined in IDL and a C#/WinRT projection produced for it. This automatically generates all marshaling logic so that calling code can pass and receive projected types. For an example of this, see the [IUserConsentVerifierInterop definition](https://github.com/microsoft/CsWinRT/blob/master/TestComponentCSharp/TestComponentCSharp.idl#L356) and [related test code](https://github.com/microsoft/CsWinRT/blob/master/UnitTest/TestComponentCSharp_Tests.cs#L1039).
If possible, the interop interface should be defined in IDL and a C#/WinRT projection produced for it. This automatically generates all marshaling logic so that calling code can pass and receive projected types. For an example of this, see the [IUserConsentVerifierInterop definition](https://github.com/microsoft/CsWinRT/blob/master/src/Tests/TestComponentCSharp/TestComponentCSharp.idl#L360) and [related test code](https://github.com/microsoft/CsWinRT/blob/master/src/Tests/UnitTest/TestComponentCSharp_Tests.cs#L1092).
Copy link
Member

Choose a reason for hiding this comment

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

Those line numbers are probably going to change often, maybe we should make a copy of the example here rather than references.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah you're right, just made an update

Copy link
Collaborator

@angelazhangmsft angelazhangmsft left a comment

Choose a reason for hiding this comment

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

thanks for catching this!

docs/interop.md Outdated Show resolved Hide resolved
docs/interop.md Outdated Show resolved Hide resolved
@j0shuams j0shuams merged commit bd1fd97 into master Dec 7, 2020
@j0shuams j0shuams deleted the jlarkin/fix-interop-links branch December 7, 2020 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants