====== State machine diagram of doxypy's internal FSM ======

{{ :doxypy:doxypy-fsm.png |State machine diagram of doxypy's internal FSM}}

^ State ^ Description ^
| ''FILEHEAD'' | First function or class definitions have yet to come. Namespace documentation and such goes here. |
| ''FILEHEAD_COMMENT_SINGLE'' | Processing comment in the filehead using single quotes. |
| ''FILEHEAD_COMMENT_DOUBLE'' | Processing comment in the filehead using double quotes. |
| ''DEFCLASS'' | Function or class definition has been found, active search for docstrings. |
| ''DEFCLASS_BODY'' | Docstring for function or class has either been found or there is none, rest of the definition gets processed. |
| ''COMMENT_SINGLE'' | Processing comment using single quotes. |
| ''COMMENT_DOUBLE'' | Processing comment using double quotes. |
| ''DEFCLASS_MULTI'' | Begin of a multiline function or class definition has be found, search for the rest of it is active. |