Skip to content

Conversation

@rpetrusha
Copy link
Contributor

Changed cross-reference, fenced xml

This PR:

  • Replaces mention of a non-existent Further Reading section with a link to a topic on XML doc elements.
  • Replaces boldfaced XML (which seems to shout at the reader) with fenced XML.

Fixes #5529

@Keboo

The example generates an .xml file with the following contents:

```xml
// This .xml file was generated with the previous code sample.
Copy link
Contributor

Choose a reason for hiding this comment

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

That line can be removed as the line above introduces the file contents.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for noticing that, @pkulikov! I'd added the introductory line above so that this line could be removed -- and then I forgot to remove it.

@mairaw mairaw removed this from the Sprint 136 (5/21/18 - 6/8/18) milestone May 22, 2018
A value tag is used to describe the property value</value>
</member>
</members>
\</doc>
Copy link
Contributor

@mairaw mairaw May 22, 2018

Choose a reason for hiding this comment

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

remove the \?

Copy link
Contributor

@mairaw mairaw left a comment

Choose a reason for hiding this comment

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

LGTM. Just need to fix the nit I found.

@rpetrusha rpetrusha merged commit 6d20c91 into dotnet:master May 22, 2018
@rpetrusha rpetrusha deleted the xml-comments branch July 26, 2018 15:49
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.

3 participants