summaryrefslogtreecommitdiffstats
path: root/doc/cpp/formula
diff options
context:
space:
mode:
Diffstat (limited to 'doc/cpp/formula')
-rw-r--r--doc/cpp/formula/formula_cell.rst10
-rw-r--r--doc/cpp/formula/formula_engine.rst19
-rw-r--r--doc/cpp/formula/formula_name_resolver.rst10
-rw-r--r--doc/cpp/formula/formula_tokens.rst19
-rw-r--r--doc/cpp/formula/index.rst12
-rw-r--r--doc/cpp/formula/types.rst14
6 files changed, 84 insertions, 0 deletions
diff --git a/doc/cpp/formula/formula_cell.rst b/doc/cpp/formula/formula_cell.rst
new file mode 100644
index 0000000..882edaf
--- /dev/null
+++ b/doc/cpp/formula/formula_cell.rst
@@ -0,0 +1,10 @@
+
+Formula Cell
+============
+
+.. doxygenclass:: ixion::formula_cell
+ :members:
+
+.. doxygenclass:: ixion::formula_result
+ :members:
+
diff --git a/doc/cpp/formula/formula_engine.rst b/doc/cpp/formula/formula_engine.rst
new file mode 100644
index 0000000..3e8fda8
--- /dev/null
+++ b/doc/cpp/formula/formula_engine.rst
@@ -0,0 +1,19 @@
+
+Formula Engine
+==============
+
+.. doxygenfunction:: ixion::parse_formula_string
+.. doxygenfunction:: ixion::print_formula_tokens
+.. doxygenfunction:: ixion::register_formula_cell
+.. doxygenfunction:: ixion::unregister_formula_cell
+.. doxygenfunction:: ixion::query_dirty_cells
+.. doxygenfunction:: ixion::query_and_sort_dirty_cells
+.. doxygenfunction:: ixion::calculate_sorted_cells
+
+
+Formula Functions
+=================
+
+.. doxygenenum:: ixion::formula_function_t
+.. doxygenfunction:: ixion::get_formula_function_name
+.. doxygenfunction:: ixion::get_formula_function_opcode
diff --git a/doc/cpp/formula/formula_name_resolver.rst b/doc/cpp/formula/formula_name_resolver.rst
new file mode 100644
index 0000000..ea9f988
--- /dev/null
+++ b/doc/cpp/formula/formula_name_resolver.rst
@@ -0,0 +1,10 @@
+
+Formula Name Resolver
+=====================
+
+.. doxygenclass:: ixion::formula_name_resolver
+ :members:
+
+.. doxygenstruct:: ixion::formula_name_t
+ :members:
+
diff --git a/doc/cpp/formula/formula_tokens.rst b/doc/cpp/formula/formula_tokens.rst
new file mode 100644
index 0000000..06d33a0
--- /dev/null
+++ b/doc/cpp/formula/formula_tokens.rst
@@ -0,0 +1,19 @@
+
+Formula Tokens
+==============
+
+.. doxygenstruct:: ixion::formula_token
+ :members:
+
+.. doxygenclass:: ixion::formula_tokens_store
+ :members:
+
+.. doxygenstruct:: ixion::named_expression_t
+ :members:
+
+Utility Functions
+-----------------
+
+.. doxygenfunction:: ixion::get_opcode_name
+
+.. doxygenfunction:: ixion::get_formula_opcode_string
diff --git a/doc/cpp/formula/index.rst b/doc/cpp/formula/index.rst
new file mode 100644
index 0000000..976405a
--- /dev/null
+++ b/doc/cpp/formula/index.rst
@@ -0,0 +1,12 @@
+
+Formula
+=======
+
+.. toctree::
+ :maxdepth: 2
+
+ formula_engine.rst
+ formula_cell.rst
+ formula_tokens.rst
+ formula_name_resolver.rst
+ types.rst
diff --git a/doc/cpp/formula/types.rst b/doc/cpp/formula/types.rst
new file mode 100644
index 0000000..9885512
--- /dev/null
+++ b/doc/cpp/formula/types.rst
@@ -0,0 +1,14 @@
+
+Types
+=====
+
+.. doxygenenum:: ixion::fopcode_t
+
+Matrix
+------
+
+.. doxygenclass:: ixion::matrix
+ :members:
+
+.. doxygenclass:: ixion::numeric_matrix
+ :members: