fml_doc_gen.read_user_function
==============================

.. py:module:: fml_doc_gen.read_user_function


Functions
---------

.. autoapisummary::

   fml_doc_gen.read_user_function.read_user_function


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

.. py:function:: read_user_function(func: Callable) -> fml_doc_gen.func_dto.FunctionDTO

   Reads the source code of the user-provided function and extracts its signature and existing docstring (if any).

   :param func: The user-defined function.
   :type func: Callable

   :returns: The function signature as a FunctionDTO object.
   :rtype: FunctionDTO

   :raises TypeError: If func is not a callable object.

   .. rubric:: Examples

   >>> def example_func(a, b):
   ...     return a + b
   ...
   >>> sigDTO = read_user_function(example_func)