:py:mod:`dissect.target.helpers.docs`
=====================================

.. py:module:: dissect.target.helpers.docs


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.target.helpers.docs.get_plugin_class_for_func
   dissect.target.helpers.docs.get_real_func_obj
   dissect.target.helpers.docs.get_docstring
   dissect.target.helpers.docs.get_func_details
   dissect.target.helpers.docs.get_full_func_name
   dissect.target.helpers.docs.get_func_description
   dissect.target.helpers.docs.get_plugin_functions_desc
   dissect.target.helpers.docs.get_plugin_description
   dissect.target.helpers.docs.get_plugin_overview



Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.helpers.docs.NO_DOCS
   dissect.target.helpers.docs.FUNCTION_OUTPUT_DESCRIPTION
   dissect.target.helpers.docs.INDENT_STEP
   dissect.target.helpers.docs.FUNC_DOC_TEMPLATE


.. py:data:: NO_DOCS
   :value: 'No documentation'

   

.. py:data:: FUNCTION_OUTPUT_DESCRIPTION

   

.. py:data:: INDENT_STEP

   

.. py:function:: get_plugin_class_for_func(func: Callable) -> Type

   Return pluging class for provided function instance


.. py:function:: get_real_func_obj(func: Callable) -> Tuple[Type, Callable]

   Return a tuple with plugin class and underlying func object for provided function instance


.. py:function:: get_docstring(obj: Any, placeholder=NO_DOCS) -> str

   Get object's docstring or a placeholder if no docstring found


.. py:function:: get_func_details(func: Callable) -> Tuple[str, str]

   Return a tuple with function's name, output label and docstring


.. py:function:: get_full_func_name(plugin_class: Type, func: Callable) -> str


.. py:data:: FUNC_DOC_TEMPLATE
   :value: '{func_name} - {short_description} (output: {output_type})'

   

.. py:function:: get_func_description(func: Callable, with_docstrings: bool = False) -> str


.. py:function:: get_plugin_functions_desc(plugin_class: Type, with_docstrings: bool = False) -> str


.. py:function:: get_plugin_description(plugin_class: Type) -> str


.. py:function:: get_plugin_overview(plugin_class: Type, with_plugin_desc: bool = False, with_func_docstrings: bool = False) -> str