.. _f-mydoxypy: module ``helpgen._my_doxypy`` ============================= .. inheritance-diagram:: pyquickhelper.helpgen._my_doxypy Short summary +++++++++++++ module ``pyquickhelper.helpgen._my_doxypy`` doxypy is an input filter for Doxygen. It preprocesses python files so that docstrings of classes and functions are reformatted into Doxygen-conform documentation blocks. In order to make Doxygen preprocess files through doxypy, simply add the following lines to your Doxyfile: - ``FILTER_SOURCE_FILES = YES`` - ``INPUT_FILTER = "python /path/to/doxypy.py"`` :githublink:`%|py|0` Classes +++++++ +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | class | truncated documentation | +===========================================================+==========================================================================================================================+ | :class:`Doxypy ` | | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :class:`FSM ` | Implements a finite state machine. Transitions are given as 4-tuples, consisting of an origin state, a target state, ... | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :class:`Opt ` | | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Functions +++++++++ +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | function | truncated documentation | +==========================================================================+===============================================================================================+ | :func:`is_file_string ` | Says if the string s could be a filename. | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :func:`main ` | Starts the parser on the file given by the filename as the first argument on the commandline. | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :func:`optParse ` | Parses commandline options. | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :func:`process_string ` | Applies the doxypy like process to a string. | +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ Methods +++++++ +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +==========================================================================================================+=====================================================================================================================+ | :py:meth:`__closeComment ` | Appends any open comment block and triggering block to the output. | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__docstringSummaryToBrief ` | Adds \brief to the docstrings summary line. A \brief is prepended, provided no other doxygen command is at the ... | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__flushBuffer ` | Flushes the current outputbuffer to the outstream. | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | Constructor for Doxypy. | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`addTransition ` | | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`appendCommentLine ` | Appends a comment line. The comment delimiter is removed from multiline start and ends as well as singleline ... | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`appendDefclassLine ` | Appends a line to the triggering block. | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`appendFileheadLine ` | Appends a line in the FILEHEAD state. Closes the open comment block, resets it and appends the current line. | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`appendNormalLine ` | Appends a line to the output. | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`catchall ` | The catchall-condition, always returns true. | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`makeCommentBlock ` | Indents the current comment block with respect to the current indentation level. | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`makeTransition ` | Makes a transition based on the given input. | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`parse ` | Parses a python file given as input string and returns the doxygen- compatible representation. | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`parseFile ` | Parses a :epkg:`python` file given as input string and returns` the :epkg:`doxygen` compatible representation. | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`parseLine ` | Parses one line of python and flush the resulting output to the outstream. | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`resetCommentSearch ` | Restarts a new comment search for a different triggering line. Closes the current commentblock and starts a new ... | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`setStartState ` | | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`startCommentSearch ` | Starts a new comment search. Saves the triggering line, resets the current comment and saves the current ... | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ | :meth:`stopCommentSearch ` | Stops a comment search. Closes the current commentblock, resets the triggering line and appends the current ... | +----------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.helpgen._my_doxypy :members: :special-members: __init__ :show-inheritance: