generate_python_api_doc Namespace Reference

Functions
	describe (obj, f, prefix="")

Variables
list	ignore
	file
	plugin_info = comin.current_get_plugin_info()
	f
	prefix
	glob = comin.descrdata_get_global()
	simulation_interval = comin.descrdata_get_simulation_interval()
	domain = comin.descrdata_get_domain(1)
	cells
	edges
	verts

Function Documentation

describe()

generate_python_api_doc.describe	(		obj,
			f,
			prefix = "" )

Definition at line 26 of file generate_python_api_doc.py.

Variable Documentation

cells

generate_python_api_doc.cells

Definition at line 73 of file generate_python_api_doc.py.

domain

generate_python_api_doc.domain = comin.descrdata_get_domain(1)

Definition at line 70 of file generate_python_api_doc.py.

edges

generate_python_api_doc.edges

Definition at line 75 of file generate_python_api_doc.py.

f

generate_python_api_doc.f

Definition at line 62 of file generate_python_api_doc.py.

file

generate_python_api_doc.file

Definition at line 57 of file generate_python_api_doc.py.

glob

generate_python_api_doc.glob = comin.descrdata_get_global()

Definition at line 64 of file generate_python_api_doc.py.

ignore

list generate_python_api_doc.ignore

Initial value:

=  [
    "dataclass",
    "ep",
    "name",
    "register_callback",
    "simulation_interval",
    "plugin_info",
]

Definition at line 16 of file generate_python_api_doc.py.

plugin_info

generate_python_api_doc.plugin_info = comin.current_get_plugin_info()

Definition at line 61 of file generate_python_api_doc.py.

prefix

generate_python_api_doc.prefix

Definition at line 62 of file generate_python_api_doc.py.

simulation_interval

generate_python_api_doc.simulation_interval = comin.descrdata_get_simulation_interval()

Definition at line 67 of file generate_python_api_doc.py.

verts

generate_python_api_doc.verts

Definition at line 77 of file generate_python_api_doc.py.