Commit 5afc3ef4 authored by yoogx's avatar yoogx
Browse files

* Documentation write-up

parent 27751aae
...@@ -27,7 +27,11 @@ def status (): ...@@ -27,7 +27,11 @@ def status ():
################################################################################ ################################################################################
def reset (): def reset ():
'''Reset Ocarina''' '''Reset Ocarina internal state
**Note:** this function must be called before processing a new set of models.
'''
libocarina_python.reset(); libocarina_python.reset();
################################################################################ ################################################################################
...@@ -61,8 +65,8 @@ def instantiate (root_system): ...@@ -61,8 +65,8 @@ def instantiate (root_system):
################################################################################ ################################################################################
Backends = Enum ([ "polyorb_hi_ada", "polyorb_hi_c"]); Backends = Enum ([ "polyorb_hi_ada", "polyorb_hi_c"]);
'''Supported backends''' '''List of supported backends, used by :data:`generate`'''
# Note, this list should match backend names as specific in Ocarina CLI # Note, this list should match backend names as specified by Ocarina CLI
def generate (generator): def generate (generator):
'''Generate code '''Generate code
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment