about summary refs log tree commit diff
path: root/doc/utilities.rst
diff options
context:
space:
mode:
authorVincent Ambo <mail@tazj.in>2020-07-15T07·20+0100
committerVincent Ambo <mail@tazj.in>2020-07-15T07·20+0100
commit7f19d641647ac4ef313ed88d6b5c140983ce5436 (patch)
tree31b66c81465293da5c093c5dde3e419758c0d6cc /doc/utilities.rst
Squashed 'third_party/immer/' content from commit ad3e3556d
git-subtree-dir: third_party/immer
git-subtree-split: ad3e3556d38bb75966dd24c61a774970a7c7957e
Diffstat (limited to 'doc/utilities.rst')
-rw-r--r--doc/utilities.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/utilities.rst b/doc/utilities.rst
new file mode 100644
index 000000000000..eaeea475c263
--- /dev/null
+++ b/doc/utilities.rst
@@ -0,0 +1,15 @@
+.. highlight:: c++
+
+Utilities
+=========
+
+The library provides also some types that, while they are not exactly
+immutable data-structures, they are very useful when using immutable
+data-structures and value-oriented design in practice.
+
+atom
+----
+
+.. doxygenclass:: immer::atom
+    :members:
+    :undoc-members: