-
Notifications
You must be signed in to change notification settings - Fork 6k
Add missing typeparamref XML documentation tag for Visual Basic #48298
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
904fc86
Initial plan
Copilot fe41b16
Add missing typeparamref XML documentation tag for Visual Basic
Copilot 851eaf3
Apply suggestions from code review
BillWagner 40f4a96
Add typeparamref to TOC and create VB project file for CI
Copilot 6f22986
Apply suggestions from code review
BillWagner df8c069
Apply suggestions from code review
BillWagner 0fe5ead
Apply suggestions from code review
BillWagner 47c1cd4
Update samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDoc…
BillWagner 254bdea
Update docs/visual-basic/language-reference/xmldoc/typeparamref.md
BillWagner File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
39 changes: 39 additions & 0 deletions
39
docs/visual-basic/language-reference/xmldoc/typeparamref.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
description: "Learn more about: <typeparamref> (Visual Basic)" | ||
title: "<typeparamref>" | ||
ms.date: 07/20/2015 | ||
helpviewer_keywords: | ||
- "typeparamref XML tag" | ||
- "<typeparamref> XML tag" | ||
ms.assetid: 8979d53b-beb1-41b7-b41e-6bbea1c17a03 | ||
BillWagner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
--- | ||
# \<typeparamref> (Visual Basic) | ||
|
||
Formats a word as a type parameter. | ||
|
||
## Syntax | ||
|
||
```xml | ||
<typeparamref name="name"/> | ||
``` | ||
|
||
## Parameters | ||
|
||
`name` | ||
The name of the type parameter to refer to. Enclose the name in double quotation marks (" "). | ||
BillWagner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Remarks | ||
|
||
The `<typeparamref>` tag gives you a way to indicate that a word is a type parameter. The XML file can be processed to format this type parameter in some distinct way, for example in italics. | ||
|
||
Compile with [-doc](../../reference/command-line-compiler/doc.md) to process documentation comments to a file. | ||
|
||
## Example | ||
|
||
This example uses the `<typeparamref>` tag to refer to the `T` type parameter. | ||
BillWagner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
[!code-vb[VbVbcnXmlDocComments#9](~/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/Class1.vb#9)] | ||
BillWagner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## See also | ||
|
||
- [XML Comment Tags](index.md) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.