Adding doxygen documentation for all vtrutils files

Author: MohamedElgammal

doc/_doxygen/vtr.dox

@@ -7,6 +7,10 @@ EXTRACT_PRIVATE        = YES
 EXTRACT_STATIC         = YES
 WARN_IF_UNDOCUMENTED   = NO
 INPUT                  = ../../libs/libvtrutil
+SORT_MEMBER_DOCS       = NO
+SORT_BRIEF_DOCS        = NO
+SORT_GROUP_NAMES       = NO
+SORT_BY_SCOPE_NAME     = NO
 RECURSIVE              = YES
 GENERATE_HTML          = NO
 GENERATE_LATEX         = NO

doc/src/api/vtrutil/container_utils.rst

@@ -0,0 +1,26 @@
+===============
+Container Utils
+===============
+
+vtr_hash
+--------
+.. doxygenfile:: vtr_hash.h
+   :project: vtr
+
+vtr_memory
+----------
+.. doxygenfile:: vtr_memory.h
+   :project: vtr
+   :sections: briefdescription detaileddescription innernamespace innerclass func
+
+vtr_pair_util
+-------------
+.. doxygenfile:: vtr_pair_util.h
+   :project: vtr
+   :sections: innernamespace innerclass briefdescription detaileddescription user-defined public-func typedef
+
+vtr_map_util
+------------
+.. doxygenfile:: vtr_map_util.h
+   :project: vtr
+

doc/src/api/vtrutil/containers.rst

@@ -2,46 +2,55 @@
 Containers
 ==========
 
-vtr_array_view
---------------
-.. doxygenfile:: vtr_array_view.h
+vtr_vector
+----------
+.. doxygenfile:: vtr_vector.h
    :project: vtr
-   :sections: innernamespace innerclass briefdescription detaileddescription user-defined public-func typedef
+   :sections: briefdescription detaileddescription innernamespace innerclass public-func typedef func
 
-vtr_bimap
----------
-.. doxygenfile:: vtr_bimap.h
+vtr_small_vector
+----------------
+.. doxygenclass:: vtr::small_vector
    :project: vtr
-   :sections: briefdescription detaileddescription innernamespace innerclass user-defined public-func derivedcompoundref typedef
+   :members:
 
-vtr_cache
----------
-.. doxygenfile:: vtr_cache.h
+vtr_vector_map
+--------------
+.. doxygenfile:: vtr_vector_map.h
    :project: vtr
-   :sections: briefdescription detaileddescription innernamespace innerclass user-defined public-func typedef
+   :sections: briefdescription detaileddescription innernamespace innerclass public-func typedef func
 
-vtr_dynamic_bitset
-------------------
-.. doxygenfile:: vtr_dynamic_bitset.h
+vtr_linear_map
+--------------
+.. doxygenfile:: vtr_linear_map.h
    :project: vtr
    :sections: briefdescription detaileddescription innernamespace func innerclass user-defined public-func typedef
 
 vtr_flat_map
 ------------
+.. doxygenclass:: vtr::flat_map
+   :project: vtr
+   :members:
+
+.. doxygenclass:: vtr::flat_map2
+   :project: vtr
+   :members:
+
 .. doxygenfile:: vtr_flat_map.h
    :project: vtr
-   :sections: briefdescription detaileddescription innernamespace func innerclass user-defined public-func typedef
+   :sections: innernamespace func
 
-vtr_hash
---------
-.. doxygenfile:: vtr_hash.h
+vtr_bimap
+---------
+.. doxygenfile:: vtr_bimap.h
    :project: vtr
+   :sections: briefdescription detaileddescription innernamespace innerclass user-defined public-func derivedcompoundref typedef
 
-vtr_linear_map
+vtr_vec_id_set
 --------------
-.. doxygenfile:: vtr_linear_map.h
+.. doxygenfile:: vtr_vec_id_set.h
    :project: vtr
-   :sections: briefdescription detaileddescription innernamespace func innerclass user-defined public-func typedef
+   :sections: briefdescription detaileddescription innernamespace innerclass public-func
 
 vtr_list
 --------
@@ -56,15 +65,11 @@ vtr_list
 .. doxygenfunction:: delete_in_vptr_list
    :project: vtr
 
-vtr_map_util
-------------
-.. doxygenfile:: vtr_map_util.h
-   :project: vtr
-
-vtr_memory
-----------
-.. doxygenfile:: vtr_memory.h
+vtr_ragged_matrix
+-----------------
+.. doxygenclass:: vtr::FlatRaggedMatrix
    :project: vtr
+   :members:
 
 vtr_ndmatrix
 ------------
@@ -78,44 +83,30 @@ vtr_ndoffsetmatrix
    :project: vtr
    :sections: innernamespace innerclass briefdescription detaileddescription user-defined public-func typedef
 
-vtr_pair_util.h
----------------
-.. doxygenfile:: vtr_pair_util.h
-   :project: vtr
-   :sections: innernamespace innerclass briefdescription detaileddescription user-defined public-func typedef
-
-vtr_ragged_matrix.h
--------------------
-.. doxygenfile:: vtr_ragged_matrix.h
-   :project: vtr
-   :sections: briefdescription detaileddescription innernamespace innerclass public-func typedef
-
-vtr_range.h
------------
-.. doxygenfile:: vtr_range.h
+vtr_array_view
+--------------
+.. doxygenclass:: vtr::array_view_id
    :project: vtr
-   :sections: briefdescription detaileddescription innernamespace func innerclass public-func typedef
+   :members:
 
-vtr_small_vector.h
-------------------
-.. doxygenfile:: vtr_small_vector.h
+.. doxygenclass:: vtr::array_view
    :project: vtr
-   :sections: briefdescription detaileddescription innernamespace innerclass public-func typedef func
+   :members:
 
-vtr_vec_id_set
---------------
-.. doxygenfile:: vtr_vec_id_set.h
+vtr_string_view
+---------------
+.. doxygenclass:: vtr::string_view
    :project: vtr
-   :sections: briefdescription detaileddescription innernamespace innerclass public-func
+   :members:
 
-vtr_vector
-----------
-.. doxygenfile:: vtr_vector.h
+vtr_cache
+---------
+.. doxygenclass:: vtr::Cache
    :project: vtr
-   :sections: briefdescription detaileddescription innernamespace innerclass public-func typedef func
+   :members:
 
-vtr_vector_map
---------------
-.. doxygenfile:: vtr_vector_map.h
+vtr_dynamic_bitset
+------------------
+.. doxygenclass:: vtr::dynamic_bitset
    :project: vtr
-   :sections: briefdescription detaileddescription innernamespace innerclass public-func typedef func
+   :members:

doc/src/api/vtrutil/geometry.rst

@@ -6,4 +6,20 @@ vtr_geometry
 ------------
 .. doxygenfile:: vtr_geometry.h
    :project: vtr
-   :sections: briefdescription detaileddescription innernamespace func innerclass user-defined public-func
+   :sections: briefdescription
+
+.. doxygenclass:: vtr::Point 
+   :project: vtr
+   :members:
+
+.. doxygenclass:: vtr::Rect 
+   :project: vtr
+   :members:
+
+.. doxygenclass:: vtr::Line 
+   :project: vtr
+   :members:
+
+.. doxygenclass:: vtr::RectUnion 
+   :project: vtr
+   :members:

doc/src/api/vtrutil/ids.rst

@@ -0,0 +1,26 @@
+============
+IDs - Ranges
+============
+
+vtr_range
+---------
+.. doxygenfile:: vtr_range.h
+   :project: vtr
+   :sections: briefdescription detaileddescription innernamespace func innerclass public-func typedef
+
+vtr_strong_id
+-------------
+.. doxygenfile:: vtr_strong_id.h
+   :project: vtr
+   :sections: briefdescription detaileddescription innernamespace 
+
+.. doxygenclass:: vtr::StrongId
+   :project: vtr
+   :members:
+
+vtr_strong_id_range
+-------------------
+.. doxygenfile:: vtr_strong_id_range.h
+   :project: vtr
+   :sections: briefdescription detaileddescription innernamespace func innerclass user-defined public-func
+

doc/src/api/vtrutil/index.rst

@@ -6,7 +6,9 @@ VTRUTIL API
 .. toctree::
    :maxdepth: 1
 
+   ids
    containers
+   container_utils
    logging
    geometry
    other

doc/src/api/vtrutil/logging.rst

@@ -1,34 +1,39 @@
-=======
-Logging
-=======
+=============================
+Logging - Errors - Assertions
+=============================
 
-vtr_assertion
--------------
-.. doxygenfile:: vtr_assert.h
+vtr_log
+-------
+.. doxygenfile:: vtr_log.h
    :project: vtr
-   :sections: briefdescription detaileddescription
+   :sections: briefdescription detaileddescription innernamespace func
 
 vtr_error
 ---------
 .. doxygenfile:: vtr_error.h
    :project: vtr
    :sections: innernamespace innerclass briefdescription detaileddescription user-defined public-func
 
-vtr_log
--------
-.. doxygenfile:: vtr_log.h
-   :project: vtr
-   :sections: briefdescription detaileddescription innernamespace func
-
-vtr_string_view
----------------
-.. doxygenfile:: vtr_string_view.h
+vtr_assertion
+-------------
+.. doxygenfile:: vtr_assert.h
    :project: vtr
-   :sections: briefdescription detaileddescription innernamespace innerclass public-func typedef func
+   :sections: briefdescription detaileddescription
 
 vtr_time
 --------
 .. doxygenfile:: vtr_time.h
    :project: vtr
-   :sections: briefdescription detaileddescription innernamespace innerclass public-func typedef func
+   :sections: briefdescription detaileddescription 
+
+.. doxygenclass:: vtr::ScopedStartFinishTimer 
+   :project: vtr
+
+.. doxygenclass:: vtr::ScopedFinishTimer 
+   :project: vtr
 
+.. doxygenclass:: vtr::ScopedActionTimer
+   :project: vtr
+
+.. doxygenclass:: vtr::Timer 
+   :project: vtr