Skip to content

Commit

Permalink
More docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nefarius committed Oct 21, 2024
1 parent b0c393a commit e6e534d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion docs/nefarius.utilities.devicemanagement.pnp.pnpdevice.md
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,7 @@ public void Remove()
#### Exceptions

[ConfigManagerException](./nefarius.utilities.devicemanagement.exceptions.configmanagerexception.md)<br>
CM API failure occurred.

**Remarks:**

Expand Down Expand Up @@ -400,7 +401,7 @@ public void Restart()

**Remarks:**

This method removes and re-enumerates (adds) the device note, which might cause unintended side-effects. If
This method removes and re-enumerates (adds) the device note, which might cause unintended side effects. If
this is the behaviour you seek, consider using [PnPDevice.RemoveAndSetup()](./nefarius.utilities.devicemanagement.pnp.pnpdevice.md#removeandsetup) instead. This method remains here for
backwards compatibility.

Expand Down
4 changes: 2 additions & 2 deletions src/PnP/PnPDevice.cs
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ protected unsafe PnPDevice(string instanceId, DeviceLocationFlags flags)
/// force-closed.
/// </summary>
/// <remarks>
/// This method removes and re-enumerates (adds) the device note, which might cause unintended side-effects. If
/// This method removes and re-enumerates (adds) the device note, which might cause unintended side effects. If
/// this is the behaviour you seek, consider using <see cref="RemoveAndSetup" /> instead. This method remains here for
/// backwards compatibility.
/// </remarks>
Expand Down Expand Up @@ -145,7 +145,7 @@ public unsafe void Restart()
/// <summary>
/// Attempts to remove this device node.
/// </summary>
/// <exception cref="ConfigManagerException"></exception>
/// <exception cref="ConfigManagerException">CM API failure occurred.</exception>
/// <remarks>
/// This call DOES NOT invoke device and driver uninstall routines, as soon as the device is re-enumerated, it
/// will reappear and become online.
Expand Down

0 comments on commit e6e534d

Please sign in to comment.