Skip to content

Update F# XML documentation (removed extraneous stars) #1357

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.

Sign up for GitHub

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 1 commit into from
Dec 26, 2016
Merged

Update F# XML documentation (removed extraneous stars) #1357

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/fsharp/language-reference/xml-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ There are two ways to write XML documentation comments. One is to just write the
|**<summary>***text***</summary>**|Specifies that *text* is a brief description of the program element. The description is usually one or two sentences.|
|**<remarks>***text***</remarks>**|Specifies that *text* contains supplementary information about the program element.|
|**<param name="***name***">***description***</param>**|Specifies the name and description for a function or method parameter.|
|**<typeparam name="***name***">***description ***</typeparam>**|Specifies the name and description for a type parameter.|
|**<typeparam name="***name***">***description***</typeparam>**|Specifies the name and description for a type parameter.|
|**<returns>***text***</returns>**|Specifies that *text* describes the return value of a function or method.|
|**<exception cref="***type***">***description***</exception>**|Specifies the type of exception that can be generated and the circumstances under which it is thrown.|
|**<see cref="***reference***">***text***</see>**|Specifies an inline link to another program element. The *reference* is the name as it appears in the XML documentation file. The *text* is the text shown in the link.|
Expand Down Expand Up @@ -62,4 +62,4 @@ The following example shows the alternative method, without XML tags. In this ex
## See Also
[F# Language Reference](index.md)

[Compiler Options](compiler-options.md)
[Compiler Options](compiler-options.md)