diff options
Diffstat (limited to 'doc/containers.rst')
-rw-r--r-- | doc/containers.rst | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/containers.rst b/doc/containers.rst new file mode 100644 index 000000000000..c6913ba4a5e5 --- /dev/null +++ b/doc/containers.rst @@ -0,0 +1,50 @@ +.. highlight:: c++ + +Containers +========== + +This section describes all the containers provided by the library. +Check the :ref:`design` section for a general discussion of these +containers and how to use them. + +box +--- + +.. doxygenclass:: immer::box + :members: + :undoc-members: + +array +----- + +.. doxygenclass:: immer::array + :members: + :undoc-members: + +vector +------ + +.. doxygenclass:: immer::vector + :members: + :undoc-members: + +flex_vector +----------- + +.. doxygenclass:: immer::flex_vector + :members: + :undoc-members: + +set +--- + +.. doxygenclass:: immer::set + :members: + :undoc-members: + +map +--- + +.. doxygenclass:: immer::map + :members: + :undoc-members: |