module sphinxext.csharp_parser
¶
Classes¶
class |
truncated documentation |
---|---|
:epkg:`C#` class. |
|
Base class of a :epkg:`C#` domaon. |
|
Base class of a :epkg:`C#` element. |
|
:epkg:`C#` function. |
|
Parses :epkg:`C#`. |
|
:epkg:`C#` Listener |
|
:epkg:`C#` type |
|
:epkg:`C#` variables |
Methods¶
method |
truncated documentation |
---|---|
constructor |
|
usual |
|
usual |
|
usual |
|
usual |
|
usual |
|
usual |
|
Adds an element. |
|
|
|
|
|
|
|
Enumerate all children. |
|
Adds an element. |
|
|
|
|
|
|
|
|
|
Returns all elements of codes inside a string. |
|
Adds an element. |
Documentation¶
-
class
pyensae.sphinxext.csharp_parser.
CSharpClass
(domain, name, methods=None, constants=None, params=None, private='public', static=False, doc=None, source=None, code=None, **kwargs)[source]¶ Bases:
pyensae.sphinxext.csharp_parser.CSharpElement
:epkg:`C#` class.
- Parameters
domain – domain
name – name
methods – methods
constants – constants
private – private, public or protected
static – static or not
doc – documentation
source – source file
code – code
-
__init__
(domain, name, methods=None, constants=None, params=None, private='public', static=False, doc=None, source=None, code=None, **kwargs)[source]¶ - Parameters
domain – domain
name – name
methods – methods
constants – constants
private – private, public or protected
static – static or not
doc – documentation
source – source file
code – code
-
class
pyensae.sphinxext.csharp_parser.
CSharpDomain
(domain, name, doc=None, source=None, code=None, **kwargs)[source]¶ Bases:
pyensae.sphinxext.csharp_parser.CSharpElement
Base class of a :epkg:`C#` domaon.
- Parameters
domain – domain
name – name
doc – documentation
source – source file
code – code
-
__init__
(domain, name, doc=None, source=None, code=None, **kwargs)[source]¶ - Parameters
domain – domain
name – name
doc – documentation
source – source file
code – code
-
class
pyensae.sphinxext.csharp_parser.
CSharpElement
(domain, name, doc=None, source=None, code=None, **kwargs)[source]¶ Bases:
object
Base class of a :epkg:`C#` element.
- Parameters
domain – domain
name – name
doc – documentation
source – source file
code – code
-
__init__
(domain, name, doc=None, source=None, code=None, **kwargs)[source]¶ - Parameters
domain – domain
name – name
doc – documentation
source – source file
code – code
-
_kinds
= {'class', 'domain', 'method', 'type'}¶
-
_privates
= {'private', 'protected', 'public'}¶
-
class
pyensae.sphinxext.csharp_parser.
CSharpMethod
(domain, name, rtype, params=None, private='public', static=False, doc=None, source=None, code=None, **kwargs)[source]¶ Bases:
pyensae.sphinxext.csharp_parser.CSharpElement
:epkg:`C#` function.
- Parameters
domain – domain
name – name
rtype – return type
private – private, public or protected
static – static or not
parameters – parameters
doc – documentation
code – code
-
__init__
(domain, name, rtype, params=None, private='public', static=False, doc=None, source=None, code=None, **kwargs)[source]¶ - Parameters
domain – domain
name – name
rtype – return type
private – private, public or protected
static – static or not
parameters – parameters
doc – documentation
code – code
-
class
pyensae.sphinxext.csharp_parser.
CSharpParser
[source]¶ Bases:
object
Parses :epkg:`C#`.
-
parse
(code, source=None)[source]¶ Returns all elements of codes inside a string.
- Parameters
code – string
source – source
- Returns
list of
CSharpElement
-
-
class
pyensae.sphinxext.csharp_parser.
CSharpParserListenerSignatures
(parser, source)[source]¶ Bases:
pyensae.languages.CSharpParserListener.CSharpParserListener
:epkg:`C#` Listener
constructor
- Parameters
parser – parser used to parse the code
-
enumerate_all_children
(ctx)[source]¶ Enumerate all children.
- Parameters
ctx – context
- Returns
iterator
-
class
pyensae.sphinxext.csharp_parser.
CSharpType
(domain, name, typ, doc=None, source=None, code=None, **kwargs)[source]¶ Bases:
pyensae.sphinxext.csharp_parser.CSharpVariable
:epkg:`C#` type
- Parameters
domain – domain
name – name
typ – type
source – source file
code – code
-
__init__
(domain, name, typ, doc=None, source=None, code=None, **kwargs)[source]¶ - Parameters
domain – domain
name – name
typ – type
source – source file
code – code
-
class
pyensae.sphinxext.csharp_parser.
CSharpVariable
(domain, name, typ, value=None, doc=None, source=None, code=None, **kwargs)[source]¶ Bases:
pyensae.sphinxext.csharp_parser.CSharpElement
:epkg:`C#` variables
- Parameters
domain – domain
name – name
typ – type
value – default value if it exists
doc – documentation
source – source file
code – code
-
__init__
(domain, name, typ, value=None, doc=None, source=None, code=None, **kwargs)[source]¶ - Parameters
domain – domain
name – name
typ – type
value – default value if it exists
doc – documentation
source – source file
code – code