Skip to content
This repository has been archived by the owner on Nov 1, 2020. It is now read-only.

Add Rd.xml documentation #8211

Merged
merged 8 commits into from
Jun 23, 2020
Merged

Add Rd.xml documentation #8211

merged 8 commits into from
Jun 23, 2020

Conversation

kant2002
Copy link
Contributor

This documentation provide examples of how rd.xml can be presented.
The only reason for this PR is #8194 (comment)

Yes, I usually copy the RD.XML from the MonoGame sample and tweak it because I don't remember it either. A volunteer who would document it would have my eternal gratitude. At least we have docs for the SerString format we can link to: dotnet/runtime#4416

Hopefully @MichalStrehovsky would keep his word 馃槈

kant2002 and others added 3 commits June 21, 2020 18:33
Co-authored-by: Lo茂c Sharma <sharma.loic@gmail.com>
Co-authored-by: Lo茂c Sharma <sharma.loic@gmail.com>
Co-authored-by: Lo茂c Sharma <sharma.loic@gmail.com>
@kant2002
Copy link
Contributor Author

@loic-sharma my understanding that parameters is just parameters. Can be generic or not. At least this is how I understand the code

Co-authored-by: Lo茂c Sharma <sharma.loic@gmail.com>
Copy link
Member

@MichalStrehovsky MichalStrehovsky left a comment

Choose a reason for hiding this comment

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

Awesome, than you! 馃

Can you also add a ## Providing hints to the compiler externally ## to the reflection-in-aot-mode.md document that will point to this one?

Documentation/using-corert/rd-xml-format.md Outdated Show resolved Hide resolved
Documentation/using-corert/rd-xml-format.md Outdated Show resolved Hide resolved
<Assembly Name="System.Private.CoreLib">
<Type Name="System.Collections.Generic.Dictionary`2[[System.Int32,System.Private.CoreLib],[System.String,System.Private.CoreLib]]">
<Method Name="EnsureCapacity">
<Parameter Name="System.Int32, System.Private.CoreLib" />
Copy link
Member

Choose a reason for hiding this comment

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

Maybe add a comment here that the Parameter is optional and it's only used to disambiguate between overloads if there are any

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Add mention that Parameter is optional.

kant2002 and others added 3 commits June 22, 2020 18:14
Co-authored-by: Michal Strehovsk媒 <MichalStrehovsky@users.noreply.github.com>
Co-authored-by: Michal Strehovsk媒 <MichalStrehovsky@users.noreply.github.com>
Copy link
Member

@MichalStrehovsky MichalStrehovsky left a comment

Choose a reason for hiding this comment

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

Thank you!

@MichalStrehovsky MichalStrehovsky merged commit 2c882f0 into dotnet:master Jun 23, 2020
@kant2002 kant2002 deleted the kant/rdxml-doc branch August 6, 2021 10:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants