Skip to content

Commit

Permalink
Generated new documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nefarius committed Mar 11, 2024
1 parent 64a0b37 commit 306499c
Show file tree
Hide file tree
Showing 23 changed files with 1,453 additions and 1,477 deletions.
56 changes: 28 additions & 28 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,55 @@
# Nefarius.Utilities.DeviceManagement
# Assembly Nefarius.Utilities.DeviceManagement

## Nefarius.Utilities.DeviceManagement.Drivers
## Namespace Nefarius.Utilities.DeviceManagement.Drivers

[DriverMeta](./nefarius.utilities.devicemanagement.drivers.drivermeta.md)
- [DriverMeta](./nefarius.utilities.devicemanagement.drivers.drivermeta.md)

[DriverStore](./nefarius.utilities.devicemanagement.drivers.driverstore.md)
- [DriverStore](./nefarius.utilities.devicemanagement.drivers.driverstore.md)

[FilterDrivers](./nefarius.utilities.devicemanagement.drivers.filterdrivers.md)
- [FilterDrivers](./nefarius.utilities.devicemanagement.drivers.filterdrivers.md)

## Nefarius.Utilities.DeviceManagement.Exceptions
## Namespace Nefarius.Utilities.DeviceManagement.Exceptions

[ConfigManagerException](./nefarius.utilities.devicemanagement.exceptions.configmanagerexception.md)
- [ConfigManagerException](./nefarius.utilities.devicemanagement.exceptions.configmanagerexception.md)

[DriverServiceNotFoundException](./nefarius.utilities.devicemanagement.exceptions.driverservicenotfoundexception.md)
- [DriverServiceNotFoundException](./nefarius.utilities.devicemanagement.exceptions.driverservicenotfoundexception.md)

[UsbPnPDeviceConversionException](./nefarius.utilities.devicemanagement.exceptions.usbpnpdeviceconversionexception.md)
- [UsbPnPDeviceConversionException](./nefarius.utilities.devicemanagement.exceptions.usbpnpdeviceconversionexception.md)

[UsbPnPDeviceException](./nefarius.utilities.devicemanagement.exceptions.usbpnpdeviceexception.md)
- [UsbPnPDeviceException](./nefarius.utilities.devicemanagement.exceptions.usbpnpdeviceexception.md)

[UsbPnPDeviceRestartException](./nefarius.utilities.devicemanagement.exceptions.usbpnpdevicerestartexception.md)
- [UsbPnPDeviceRestartException](./nefarius.utilities.devicemanagement.exceptions.usbpnpdevicerestartexception.md)

[Win32Exception](./nefarius.utilities.devicemanagement.exceptions.win32exception.md)
- [Win32Exception](./nefarius.utilities.devicemanagement.exceptions.win32exception.md)

## Nefarius.Utilities.DeviceManagement.Extensions
## Namespace Nefarius.Utilities.DeviceManagement.Extensions

[PnPDeviceExtensions](./nefarius.utilities.devicemanagement.extensions.pnpdeviceextensions.md)
- [PnPDeviceExtensions](./nefarius.utilities.devicemanagement.extensions.pnpdeviceextensions.md)

## Nefarius.Utilities.DeviceManagement.PnP
## Namespace Nefarius.Utilities.DeviceManagement.PnP

[CustomDeviceProperty](./nefarius.utilities.devicemanagement.pnp.customdeviceproperty.md)
- [CustomDeviceProperty](./nefarius.utilities.devicemanagement.pnp.customdeviceproperty.md)

[Devcon](./nefarius.utilities.devicemanagement.pnp.devcon.md)
- [Devcon](./nefarius.utilities.devicemanagement.pnp.devcon.md)

[DeviceClassFilters](./nefarius.utilities.devicemanagement.pnp.deviceclassfilters.md)
- [DeviceClassFilters](./nefarius.utilities.devicemanagement.pnp.deviceclassfilters.md)

[DeviceClassIds](./nefarius.utilities.devicemanagement.pnp.deviceclassids.md)
- [DeviceClassIds](./nefarius.utilities.devicemanagement.pnp.deviceclassids.md)

[DeviceEventArgs](./nefarius.utilities.devicemanagement.pnp.deviceeventargs.md)
- [DeviceEventArgs](./nefarius.utilities.devicemanagement.pnp.deviceeventargs.md)

[DeviceInterfaceIds](./nefarius.utilities.devicemanagement.pnp.deviceinterfaceids.md)
- [DeviceInterfaceIds](./nefarius.utilities.devicemanagement.pnp.deviceinterfaceids.md)

[DeviceLocationFlags](./nefarius.utilities.devicemanagement.pnp.devicelocationflags.md)
- [DeviceLocationFlags](./nefarius.utilities.devicemanagement.pnp.devicelocationflags.md)

[DeviceNotificationListener](./nefarius.utilities.devicemanagement.pnp.devicenotificationlistener.md)
- [DeviceNotificationListener](./nefarius.utilities.devicemanagement.pnp.devicenotificationlistener.md)

[DevicePropertyKey](./nefarius.utilities.devicemanagement.pnp.devicepropertykey.md)
- [DevicePropertyKey](./nefarius.utilities.devicemanagement.pnp.devicepropertykey.md)

[IDeviceNotificationListener](./nefarius.utilities.devicemanagement.pnp.idevicenotificationlistener.md)
- [IDeviceNotificationListener](./nefarius.utilities.devicemanagement.pnp.idevicenotificationlistener.md)

[IPnPDevice](./nefarius.utilities.devicemanagement.pnp.ipnpdevice.md)
- [IPnPDevice](./nefarius.utilities.devicemanagement.pnp.ipnpdevice.md)

[PnPDevice](./nefarius.utilities.devicemanagement.pnp.pnpdevice.md)
- [PnPDevice](./nefarius.utilities.devicemanagement.pnp.pnpdevice.md)

[UsbPnPDevice](./nefarius.utilities.devicemanagement.pnp.usbpnpdevice.md)
- [UsbPnPDevice](./nefarius.utilities.devicemanagement.pnp.usbpnpdevice.md)
14 changes: 7 additions & 7 deletions docs/nefarius.utilities.devicemanagement.drivers.drivermeta.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
## Properties

### **DriverDate**
### <a id="properties-driverdate"/>**DriverDate**

Gets the date of the driver.

Expand All @@ -24,7 +24,7 @@ public DateTime DriverDate { get; internal set; }

[DateTime](https://docs.microsoft.com/en-us/dotnet/api/system.datetime)<br>
### **DriverDescription**
### <a id="properties-driverdescription"/>**DriverDescription**

Gets the description the device got from the function driver.

Expand All @@ -36,7 +36,7 @@ public string DriverDescription { get; internal set; }

[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
### **DriverVersion**
### <a id="properties-driverversion"/>**DriverVersion**

Gets the driver version.

Expand All @@ -48,7 +48,7 @@ public Version DriverVersion { get; internal set; }

[Version](https://docs.microsoft.com/en-us/dotnet/api/system.version)<br>
### **InfPath**
### <a id="properties-infpath"/>**InfPath**

Gets the active INF name/sub-path. Typically resides in C:\Windows\INF.

Expand All @@ -60,7 +60,7 @@ public string InfPath { get; internal set; }

[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
### **InfSection**
### <a id="properties-infsection"/>**InfSection**

Gets the section of the INF which applied on driver installation.

Expand All @@ -72,7 +72,7 @@ public string InfSection { get; internal set; }

[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
### **MatchingDeviceId**
### <a id="properties-matchingdeviceid"/>**MatchingDeviceId**

Gets the device ID this driver is active on.

Expand All @@ -84,7 +84,7 @@ public string MatchingDeviceId { get; internal set; }

[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
### **ProviderName**
### <a id="properties-providername"/>**ProviderName**

Gets the provider (manufacturer) name of the driver.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
## Properties

### **ExistingDrivers**
### <a id="properties-existingdrivers"/>**ExistingDrivers**

Gets a list of existing packages (absolute INF paths) in the local driver store.

```csharp
public static IEnumerable<string> ExistingDrivers { get; }
public static IEnumerable<String> ExistingDrivers { get; }
```

#### Property Value
Expand All @@ -26,7 +26,7 @@ public static IEnumerable<string> ExistingDrivers { get; }
## Methods

### **RemoveDriver(String)**
### <a id="methods-removedriver"/>**RemoveDriver(String)**

Removes a driver identified by absolute package path.

Expand Down
62 changes: 30 additions & 32 deletions docs/nefarius.utilities.devicemanagement.drivers.filterdrivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,80 +12,78 @@ Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
## Methods

### **GetDeviceClassUpperFilters(Guid)**
### <a id="methods-adddeviceclasslowerfilter"/>**AddDeviceClassLowerFilter(Guid, String)**

Gets the upper filter service names (if any) for a provided class GUID.
Adds a driver service to the lower filters of a provided class GUID.

```csharp
public static IEnumerable<string> GetDeviceClassUpperFilters(Guid classGuid)
public static void AddDeviceClassLowerFilter(Guid classGuid, string serviceName)
```

#### Parameters

`classGuid` [Guid](https://docs.microsoft.com/en-us/dotnet/api/system.guid)<br>
The device class GUID.

#### Returns

[IEnumerable&lt;String&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)<br>
A list of filter service names.
`serviceName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
The driver service name to add.

### **GetDeviceClassLowerFilters(Guid)**
### <a id="methods-adddeviceclassupperfilter"/>**AddDeviceClassUpperFilter(Guid, String)**

Gets the lower filter service names (if any) for a provided class GUID.
Adds a driver service to the upper filters of a provided class GUID.

```csharp
public static IEnumerable<string> GetDeviceClassLowerFilters(Guid classGuid)
public static void AddDeviceClassUpperFilter(Guid classGuid, string serviceName)
```

#### Parameters

`classGuid` [Guid](https://docs.microsoft.com/en-us/dotnet/api/system.guid)<br>
The device class GUID.

#### Returns

[IEnumerable&lt;String&gt;](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1)<br>
A list of filter service names.
`serviceName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
The driver service name to add.

### **RemoveDeviceClassUpperFilter(Guid, String)**
### <a id="methods-getdeviceclasslowerfilters"/>**GetDeviceClassLowerFilters(Guid)**

Removes a driver service from the upper filters of a provided class GUID.
Gets the lower filter service names (if any) for a provided class GUID.

```csharp
public static void RemoveDeviceClassUpperFilter(Guid classGuid, string serviceName)
public static IEnumerable<String> GetDeviceClassLowerFilters(Guid classGuid)
```

#### Parameters

`classGuid` [Guid](https://docs.microsoft.com/en-us/dotnet/api/system.guid)<br>
The device class GUID.

`serviceName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
The driver service name to remove.
#### Returns

### **RemoveDeviceClassLowerFilter(Guid, String)**
A list of filter service names.

Removes a driver service from the lower filters of a provided class GUID.
### <a id="methods-getdeviceclassupperfilters"/>**GetDeviceClassUpperFilters(Guid)**

Gets the upper filter service names (if any) for a provided class GUID.

```csharp
public static void RemoveDeviceClassLowerFilter(Guid classGuid, string serviceName)
public static IEnumerable<String> GetDeviceClassUpperFilters(Guid classGuid)
```

#### Parameters

`classGuid` [Guid](https://docs.microsoft.com/en-us/dotnet/api/system.guid)<br>
The device class GUID.

`serviceName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
The driver service name to remove.
#### Returns

### **AddDeviceClassUpperFilter(Guid, String)**
A list of filter service names.

Adds a driver service to the upper filters of a provided class GUID.
### <a id="methods-removedeviceclasslowerfilter"/>**RemoveDeviceClassLowerFilter(Guid, String)**

Removes a driver service from the lower filters of a provided class GUID.

```csharp
public static void AddDeviceClassUpperFilter(Guid classGuid, string serviceName)
public static void RemoveDeviceClassLowerFilter(Guid classGuid, string serviceName)
```

#### Parameters
Expand All @@ -94,14 +92,14 @@ public static void AddDeviceClassUpperFilter(Guid classGuid, string serviceName)
The device class GUID.

`serviceName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
The driver service name to add.
The driver service name to remove.

### **AddDeviceClassLowerFilter(Guid, String)**
### <a id="methods-removedeviceclassupperfilter"/>**RemoveDeviceClassUpperFilter(Guid, String)**

Adds a driver service to the lower filters of a provided class GUID.
Removes a driver service from the upper filters of a provided class GUID.

```csharp
public static void AddDeviceClassLowerFilter(Guid classGuid, string serviceName)
public static void RemoveDeviceClassUpperFilter(Guid classGuid, string serviceName)
```

#### Parameters
Expand All @@ -110,4 +108,4 @@ public static void AddDeviceClassLowerFilter(Guid classGuid, string serviceName)
The device class GUID.

`serviceName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
The driver service name to add.
The driver service name to remove.
Loading

0 comments on commit 306499c

Please sign in to comment.