Update README.md & add sample snippets #1591
Conversation
jevansaks
left a comment
There was a problem hiding this comment.
This is great! Thank you for taking the initiative to get this started. I've been wanting to have a place to add more examples for a while.
|
This also fixes #1259, I'll update the PR description. Edit: I see you already did. Thanks! :) |
| @@ -0,0 +1,188 @@ | ||
| # Code examples | ||
|
|
||
| When, for example, marshaling is enabled and `useSafeHandles` is `true`, the code can be different than that in C++. Here we show a few code examples of using CsWin32. |
There was a problem hiding this comment.
I just realized, in reading this, that there's no SafeHandle examples. Could you include some? If not, I can do it as a follow-up.
There was a problem hiding this comment.
The first sample uses SafeHandle
CsWin32/docfx/docs/Examples.md
Lines 30 to 45 in e58c957
There was a problem hiding this comment.
I can do it as a follow-up.
However, please feel free to update the changes as you like.
|
/azp run |
| * `SafeHandle`-types automatically generated. | ||
| * Generates xml documentation based on and links back to learn.microsoft.com | ||
| - [Getting started](https://microsoft.github.io/CsWin32/docs/getting-started.html) | ||
| - [Examples](https://microsoft.github.io/CsWin32/docs/examples.html) |
There was a problem hiding this comment.
URLs are case sensitive. Your Examples.md will produce Examples.html
| - [Examples](https://microsoft.github.io/CsWin32/docs/examples.html) | |
| - [Examples](https://microsoft.github.io/CsWin32/docs/Examples.html) |
As the title, I updated README.md and added sample snippets.
Please see the changes on GitHub too.
Resolves #1259