Skip to content

Commit

Permalink
fix paramrefs
Browse files Browse the repository at this point in the history
  • Loading branch information
gewarren committed Dec 28, 2024
1 parent 4530175 commit 71b741f
Show file tree
Hide file tree
Showing 27 changed files with 1,533 additions and 1,561 deletions.
264 changes: 132 additions & 132 deletions xml/System.Device.Location/GeoCoordinate.xml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion xml/System.Diagnostics/ActivityContext.xml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ ActivityContext contains the property `IsRemote`, which is not part of W3C. `IsR
<param name="value">The object to compare to this instance.</param>
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
<returns>
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
<see langword="true" /> if the current object is equal to the <paramref name="value" /> parameter; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Diagnostics/ActivityLink.xml
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Activity links can be used to represent batched operations where an activity was
<param name="value">The activity link to compare.</param>
<summary>Indicates whether the current activity link is equal to another activity link.</summary>
<returns>
<see langword="true" /> if the current activity link is equal to <paramref name="other" />; otherwise, <see langword="false" />.</returns>
<see langword="true" /> if the current activity link is equal to <paramref name="value" />; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down
18 changes: 7 additions & 11 deletions xml/System.Diagnostics/EventLog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3353,7 +3353,7 @@ SVC_UPDATE.EXE
Use this method to write an entry of a specified <xref:System.Diagnostics.EventLogEntryType> to the event log. The `type` is indicated by an icon and text in the Type column in the Event Viewer for a log.
> [!NOTE]
> The `message` string cannot contain %*n*, where *n* is an integer value (for example, %1), because the event viewer treats it as an insertion string. Because an Internet Protocol, version 6 (IPv6) address can contain this character sequence, you cannot log an event message that contains an IPv6 address.
> The `message` string cannot contain %*n*, where *n* is an integer value (for example, %1), because the event viewer treats it as an insertion string. Because an Internet Protocol, version 6 (IPv6) address can contain this character sequence, you cannot log an event message that contains an IPv6 address.
You must set the <xref:System.Diagnostics.EventLog.Source%2A> property on your <xref:System.Diagnostics.EventLog> component before you can write entries to the log. You must create and configure the event source before writing the first entry with the source.
Expand All @@ -3377,9 +3377,7 @@ SVC_UPDATE.EXE
> If you write an entry to a remote computer, the value of the message (the text string) might not be what you expect if the remote computer is not running the .NET Framework.
> [!NOTE]
> If the `message` parameter contains a NUL character, the message in the event log is terminated at the NUL character.
> If the `message` parameter contains a NUL character, the message in the event log is terminated at the NUL character.
## Examples
The following example writes a warning entry to an event log, "MyNewLog", on the local computer.
Expand Down Expand Up @@ -3464,6 +3462,7 @@ SVC_UPDATE.EXE
<format type="text/markdown"><![CDATA[
## Remarks
Use this method to write an information entry to the event log, using a source that is already registered as an event source for the appropriate log. If you want to specify any other <xref:System.Diagnostics.EventLogEntryType>, use a different overload of <xref:System.Diagnostics.EventLog.WriteEntry%2A>.
You must create and configure the event source before writing the first entry with the source. Create the new event source during the installation of your application. This allows time for the operating system to refresh its list of registered event sources and their configuration. If the operating system has not refreshed its list of event sources, and you attempt to write an event with the new source, the write operation will fail. You can configure a new source using an <xref:System.Diagnostics.EventLogInstaller>, or using the <xref:System.Diagnostics.EventLog.CreateEventSource%2A> method. You must have administrative rights on the computer to create a new event source.
Expand All @@ -3473,11 +3472,9 @@ SVC_UPDATE.EXE
If your application writes entries using both resource identifiers and string values, you must register two separate sources. For example, configure one source with resource files, and then use that source in the <xref:System.Diagnostics.EventLog.WriteEvent%2A> method to write entries using resource identifiers to the event log. Then create a different source without resource files, and use that source in the <xref:System.Diagnostics.EventLog.WriteEntry%2A> method to write strings directly to the event log using that source.
> [!NOTE]
> If the `message` parameter contains a NUL character, the message in the event log is terminated at the NUL character.
> If the `message` parameter contains a NUL character, the message in the event log is terminated at the NUL character.
>
> The `message` string cannot contain %*n*, where *n* is an integer value (for example, %1), because the event viewer treats it as an insertion string. Because an Internet Protocol, version 6 (IPv6) address can contain this character sequence, you cannot log an event message that contains an IPv6 address.
> The `message` string cannot contain %*n*, where *n* is an integer value (for example, %1), because the event viewer treats it as an insertion string. Because an Internet Protocol, version 6 (IPv6) address can contain this character sequence, you cannot log an event message that contains an IPv6 address.
## Examples
The following example creates the source `MySource` if it does not already exist, and writes an entry to the event log `MyNewLog`.
Expand Down Expand Up @@ -4370,6 +4367,7 @@ SVC_UPDATE.EXE
<format type="text/markdown"><![CDATA[
## Remarks
Use this method to write a localized entry to the event log. You specify the event properties with resource identifiers rather than string values. The Event Viewer uses the resource identifiers to display the corresponding strings from the localized resource file for the <xref:System.Diagnostics.EventLog.Source%2A>. You must register the source with the corresponding resource file before you write events using resource identifiers.
The input `instance` instance specifies the event message and properties. Set the <xref:System.Diagnostics.EventInstance.InstanceId%2A> of the `instance` input for the defined message in the source message resource file. You can optionally set the <xref:System.Diagnostics.EventInstance.CategoryId%2A> and <xref:System.Diagnostics.EventInstance.EntryType%2A> of the `instance` input to define the category and event type of your event entry. You can also specify an array of language-independent strings to insert into the localized message text. Set `values` to `null` if the event message does not contain formatting placeholders for replacement strings.
Expand All @@ -4383,9 +4381,7 @@ SVC_UPDATE.EXE
If your application writes entries using both resource identifiers and string values, you must register two separate sources. For example, configure one source with resource files, and then use that source in the <xref:System.Diagnostics.EventLog.WriteEvent%2A> method to write entries using resource identifiers to the event log. Then create a different source without resource files, and use that source in the <xref:System.Diagnostics.EventLog.WriteEntry%2A> method to write strings directly to the event log using that source.
> [!NOTE]
> If you write an entry to a remote computer, the value of the `message` string might not be what you expect if the remote computer is not running the .NET Framework. Also, the `message` string cannot contain %*n*, where *n* is an integer value (for example, %1), because the event viewer treats it as an insertion string. Because an Internet Protocol, version 6 (IPv6) address can contain this character sequence, you cannot log an event message that contains an IPv6 address.
> If you write an entry to a remote computer, the value of the `message` string might not be what you expect if the remote computer is not running .NET. Also, the `message` string cannot contain %*n*, where *n* is an integer value (for example, %1), because the event viewer treats it as an insertion string. Because an Internet Protocol, version 6 (IPv6) address can contain this character sequence, you cannot log an event message that contains an IPv6 address.
## Examples
The following example writes two audit entries to the event log `myNewLog`. The example creates a new event source and a new event log if they do not exist on the local computer. The event message text is specified using a resource identifier in a resource file.
Expand Down
Loading

0 comments on commit 71b741f

Please sign in to comment.