.. _f-csharpparser:

module ``sphinxext.csharp_parser``
==================================





.. inheritance-diagram:: pyensae.sphinxext.csharp_parser


Short summary
+++++++++++++

module ``pyensae.sphinxext.csharp_parser``

Parses :epkg:`C# `.


:githublink:`%|py|6`




Classes
+++++++

+----------------------------------------------------------------------------------------------------------+-------------------------------------+
| class                                                                                                    | truncated documentation             |
+==========================================================================================================+=====================================+
| :class:`CSharpClass <pyensae.sphinxext.csharp_parser.CSharpClass>`                                       | :epkg:`C#` class.                   |
+----------------------------------------------------------------------------------------------------------+-------------------------------------+
| :class:`CSharpDomain <pyensae.sphinxext.csharp_parser.CSharpDomain>`                                     | Base class of a :epkg:`C#` domaon.  |
+----------------------------------------------------------------------------------------------------------+-------------------------------------+
| :class:`CSharpElement <pyensae.sphinxext.csharp_parser.CSharpElement>`                                   | Base class of a :epkg:`C#` element. |
+----------------------------------------------------------------------------------------------------------+-------------------------------------+
| :class:`CSharpMethod <pyensae.sphinxext.csharp_parser.CSharpMethod>`                                     | :epkg:`C#` function.                |
+----------------------------------------------------------------------------------------------------------+-------------------------------------+
| :class:`CSharpParser <pyensae.sphinxext.csharp_parser.CSharpParser>`                                     | Parses :epkg:`C#`.                  |
+----------------------------------------------------------------------------------------------------------+-------------------------------------+
| :class:`CSharpParserListenerSignatures <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures>` | :epkg:`C#` Listener                 |
+----------------------------------------------------------------------------------------------------------+-------------------------------------+
| :class:`CSharpType <pyensae.sphinxext.csharp_parser.CSharpType>`                                         | :epkg:`C#` type                     |
+----------------------------------------------------------------------------------------------------------+-------------------------------------+
| :class:`CSharpVariable <pyensae.sphinxext.csharp_parser.CSharpVariable>`                                 | :epkg:`C#` variables                |
+----------------------------------------------------------------------------------------------------------+-------------------------------------+










Methods
+++++++

+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| method                                                                                                                           | truncated documentation                        |
+==================================================================================================================================+================================================+
| :py:meth:`__init__ <pyensae.sphinxext.csharp_parser.CSharpClass.__init__>`                                                       |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :py:meth:`__init__ <pyensae.sphinxext.csharp_parser.CSharpDomain.__init__>`                                                      |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :py:meth:`__init__ <pyensae.sphinxext.csharp_parser.CSharpElement.__init__>`                                                     |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :py:meth:`__init__ <pyensae.sphinxext.csharp_parser.CSharpMethod.__init__>`                                                      |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :py:meth:`__init__ <pyensae.sphinxext.csharp_parser.CSharpParser.__init__>`                                                      |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :py:meth:`__init__ <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures.__init__>`                                    | constructor                                    |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :py:meth:`__init__ <pyensae.sphinxext.csharp_parser.CSharpType.__init__>`                                                        |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :py:meth:`__init__ <pyensae.sphinxext.csharp_parser.CSharpVariable.__init__>`                                                    |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :py:meth:`__str__ <pyensae.sphinxext.csharp_parser.CSharpClass.__str__>`                                                         | usual                                          |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :py:meth:`__str__ <pyensae.sphinxext.csharp_parser.CSharpDomain.__str__>`                                                        | usual                                          |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :py:meth:`__str__ <pyensae.sphinxext.csharp_parser.CSharpElement.__str__>`                                                       | usual                                          |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :py:meth:`__str__ <pyensae.sphinxext.csharp_parser.CSharpMethod.__str__>`                                                        | usual                                          |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :py:meth:`__str__ <pyensae.sphinxext.csharp_parser.CSharpType.__str__>`                                                          | usual                                          |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :py:meth:`__str__ <pyensae.sphinxext.csharp_parser.CSharpVariable.__str__>`                                                      | usual                                          |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :meth:`enter_body <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures.enter_body>`                                   | Adds an element.                               |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :meth:`enterNamespace_body <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures.enterNamespace_body>`                 |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :meth:`enterNamespace_declaration <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures.enterNamespace_declaration>`   |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :meth:`enterNamespace_or_type_name <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures.enterNamespace_or_type_name>` |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :meth:`enumerate_all_children <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures.enumerate_all_children>`           | Enumerate all children.                        |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :meth:`exit_body <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures.exit_body>`                                     | Adds an element.                               |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :meth:`exitNamespace_body <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures.exitNamespace_body>`                   |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :meth:`exitNamespace_declaration <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures.exitNamespace_declaration>`     |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :meth:`exitNamespace_or_type_name <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures.exitNamespace_or_type_name>`   |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :meth:`get_code <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures.get_code>`                                       |                                                |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :meth:`parse <pyensae.sphinxext.csharp_parser.CSharpParser.parse>`                                                               | Returns all elements of codes inside a string. |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| :meth:`stack_element <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures.stack_element>`                             | Adds an element.                               |
+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pyensae.sphinxext.csharp_parser
    :members:
    :special-members: __init__
    :show-inheritance: