From 996487cc1f994f018ab6ebc389ced6d050aea500 Mon Sep 17 00:00:00 2001 From: hakril Date: Sun, 10 May 2020 20:26:48 +0200 Subject: [PATCH] Added device manager documentation skeleton to docs/ as well as samples output --- docs/source/device_manager.rst | 50 +++++++++++++++++++ docs/source/sample.rst | 21 ++++++++ .../device_manager_device_manager.txt | 19 +++++++ .../device_manager_enum_devices.txt | 34 +++++++++++++ docs/source/winobject.rst | 1 + 5 files changed, 125 insertions(+) create mode 100644 docs/source/device_manager.rst create mode 100644 docs/source/samples_output/device_manager_device_manager.txt create mode 100644 docs/source/samples_output/device_manager_enum_devices.txt diff --git a/docs/source/device_manager.rst b/docs/source/device_manager.rst new file mode 100644 index 0000000..cd282b4 --- /dev/null +++ b/docs/source/device_manager.rst @@ -0,0 +1,50 @@ +Device Manager +============== + +.. module:: windows.winobject.device_manager + +The :class:`DeviceManager` instance is accessible via :py:attr:`windows.system.device_manager +` + +.. note:: + + See sample at :ref:`sample_device_manager` + + + +DeviceManager +""""""""""""" + + +.. autoclass:: DeviceManager + :members: + :undoc-members: + + +DeviceClass +""""""""""" + + +.. autoclass:: DeviceClass + :members: + :undoc-members: + + + +DeviceInformationSet +"""""""""""""""""""" + + +.. autoclass:: DeviceInformationSet + :members: + :undoc-members: + + + +DeviceInstance +"""""""""""""" + + +.. autoclass:: DeviceInformationSet + :members: + :undoc-members: \ No newline at end of file diff --git a/docs/source/sample.rst b/docs/source/sample.rst index dd411cc..fed024a 100644 --- a/docs/source/sample.rst +++ b/docs/source/sample.rst @@ -162,6 +162,27 @@ Output .. literalinclude:: samples_output\object_manager_findobj.txt +.. _sample_device_manager: + +Device manager +"""""""""""""" + +.. literalinclude:: ..\..\samples\device_manager\device_manager.py + +Output + +.. literalinclude:: samples_output\device_manager_device_manager.txt + + +Enumerate devices +''''''''''''''''' + +.. literalinclude:: ..\..\samples\device_manager\enum_devices.py + + +.. literalinclude:: samples_output\device_manager_enum_devices.txt + + .. _sample_wintrust: ``windows.wintrust`` diff --git a/docs/source/samples_output/device_manager_device_manager.txt b/docs/source/samples_output/device_manager_device_manager.txt new file mode 100644 index 0000000..ef26d95 --- /dev/null +++ b/docs/source/samples_output/device_manager_device_manager.txt @@ -0,0 +1,19 @@ +(cmd) python device_manager\device_manager.py +Device manager is +Enumerating the first 3 device classes + * + * + * +Finding device class 'System' + * + Enumerating some devices of 'System' + * + * + Enumerating allocated resources: + * + * + * + Enumerating allocated resources: + * + * + * diff --git a/docs/source/samples_output/device_manager_enum_devices.txt b/docs/source/samples_output/device_manager_enum_devices.txt new file mode 100644 index 0000000..2ac649e --- /dev/null +++ b/docs/source/samples_output/device_manager_enum_devices.txt @@ -0,0 +1,34 @@ +$ python64 device_manager\enum_devices.py --no-print-devices +Namespace(clsfilter=None, no_print_devices=True, print_resources=False) + + + + + + + + + +.... + +$ python64 device_manager\enum_devices.py --class Processor +Namespace(clsfilter='Processor', no_print_devices=False, print_resources=False) + + * + * + * + * + + +$ python64 device_manager\enum_devices.py --class Display --print-resources +Namespace(clsfilter='Display', no_print_devices=False, print_resources=True) + + * + * + * + * + * + * + * + * + ... \ No newline at end of file diff --git a/docs/source/winobject.rst b/docs/source/winobject.rst index e0737b5..4b99dc8 100644 --- a/docs/source/winobject.rst +++ b/docs/source/winobject.rst @@ -20,5 +20,6 @@ This sections describes them by group of relation. handle.rst system_module.rst object_manager.rst + device_manager.rst task_scheduler.rst evtlog.rst \ No newline at end of file