Adding doxygen documentation for VTR utilities

doc/_doxygen/vtr.dox

@@ -0,0 +1,17 @@
+PROJECT_NAME           = "Verilog to Routing - VTR"
+OUTPUT_DIRECTORY       = ../_build/doxygen/vtr
+FULL_PATH_NAMES        = NO
+OPTIMIZE_OUTPUT_FOR_C  = YES
+EXTRACT_ALL            = YES
+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
+GENERATE_XML           = YES

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

@@ -0,0 +1,112 @@
+==========
+Containers
+==========
+
+vtr_vector
+----------
+.. doxygenfile:: vtr_vector.h
+   :project: vtr
+   :sections: briefdescription detaileddescription innernamespace innerclass public-func typedef func
+
+vtr_small_vector
+----------------
+.. doxygenclass:: vtr::small_vector
+   :project: vtr
+   :members:
+
+vtr_vector_map
+--------------
+.. doxygenfile:: vtr_vector_map.h
+   :project: vtr
+   :sections: briefdescription detaileddescription innernamespace innerclass public-func typedef func
+
+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: innernamespace func
+
+vtr_bimap
+---------
+.. doxygenfile:: vtr_bimap.h
+   :project: vtr
+   :sections: briefdescription detaileddescription innernamespace innerclass user-defined public-func derivedcompoundref typedef
+
+vtr_vec_id_set
+--------------
+.. doxygenfile:: vtr_vec_id_set.h
+   :project: vtr
+   :sections: briefdescription detaileddescription innernamespace innerclass public-func
+
+vtr_list
+--------
+.. doxygenfile:: vtr_list.h
+   :project: vtr
+   :sections: briefdescription detaileddescription innernamespace struct innerclass user-defined public-func typedef
+
+.. doxygenfunction:: insert_in_vptr_list
+   :project: vtr
+
+
+.. doxygenfunction:: delete_in_vptr_list
+   :project: vtr
+
+vtr_ragged_matrix
+-----------------
+.. doxygenclass:: vtr::FlatRaggedMatrix
+   :project: vtr
+   :members:
+
+vtr_ndmatrix
+------------
+.. doxygenfile:: vtr_ndmatrix.h
+   :project: vtr
+   :sections: innernamespace innerclass briefdescription detaileddescription user-defined public-func typedef
+
+vtr_ndoffsetmatrix
+------------------
+.. doxygenfile:: vtr_ndoffsetmatrix.h
+   :project: vtr
+   :sections: innernamespace innerclass briefdescription detaileddescription user-defined public-func typedef
+
+vtr_array_view
+--------------
+.. doxygenclass:: vtr::array_view_id
+   :project: vtr
+   :members:
+
+.. doxygenclass:: vtr::array_view
+   :project: vtr
+   :members:
+
+vtr_string_view
+---------------
+.. doxygenclass:: vtr::string_view
+   :project: vtr
+   :members:
+
+vtr_cache
+---------
+.. doxygenclass:: vtr::Cache
+   :project: vtr
+   :members:
+
+vtr_dynamic_bitset
+------------------
+.. doxygenclass:: vtr::dynamic_bitset
+   :project: vtr
+   :members:

doc/src/api/vtrutil/geometry.rst

@@ -0,0 +1,25 @@
+========
+Geometry
+========
+
+vtr_geometry
+------------
+.. doxygenfile:: vtr_geometry.h
+   :project: vtr
+   :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

@@ -0,0 +1,14 @@
+.. _vtrutil_api:
+
+VTRUTIL API
+============
+
+.. toctree::
+   :maxdepth: 1
+
+   ids
+   containers
+   container_utils
+   logging
+   geometry
+   other

doc/src/api/vtrutil/logging.rst

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