[doc] Add Modules page to doxgen documentation

Author: Pawel Karczewski

CONTRIBUTING.md

@@ -37,6 +37,8 @@ make cppformat
 
 * Each new feature should be documented using doxygen comment blocks.
 * Each non-member function should be added to corresponding class documentation by `@relates` tag
+* Each new API should be assigned to group by `@ingroup` tag. See [groups definitions file](doc/groups_definitions.dox) in the repository for details.
+
 # Submitting Pull Requests
 
 We take outside code contributions to `libpmemobj-cpp` through GitHub pull requests.

doc/groups_definitions.dox

@@ -0,0 +1,11 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2021, Intel Corporation
+
+/** @defgroup containers  Containers*/
+/** @defgroup experimental_containers Experimental Containers */
+/** @defgroup transactions Transactions*/
+/** @defgroup allocation Allocation*/
+/** @defgroup data_view Data View*/
+/** @defgroup synchronization Synchronization Primitives*/
+/** @defgroup primitives Primitives*/
+/** @defgroup exceptions Exceptions*/

doc/libpmemobj++.Doxyfile.in

@@ -868,7 +868,8 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = @LIBPMEMOBJCPP_ROOT_DIR@/include/libpmemobj++ \
-                         @LIBPMEMOBJCPP_ROOT_DIR@/include/libpmemobj++/README.md
+                         @LIBPMEMOBJCPP_ROOT_DIR@/include/libpmemobj++/README.md \
+                         @LIBPMEMOBJCPP_ROOT_DIR@/doc/groups_definitions.dox
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

include/libpmemobj++/allocator.hpp

@@ -25,6 +25,7 @@ namespace obj
 /**
  * Encapsulates object specific allocator functionality. Designed to be used
  * with C++ allocators. Can be specialized if necessary.
+ * @ingroup allocation
  */
 template <typename T>
 class object_traits {
@@ -137,6 +138,7 @@ class object_traits {
 /**
  * Object traits specialization for the void type. Designed to be used
  * with C++ allocators. Can be specialized if necessary.
+ * @ingroup allocation
  */
 template <>
 class object_traits<void> {
@@ -179,6 +181,7 @@ class object_traits<void> {
  *
  * Can be specialized for a given type. Designed to be used with C++ allocators.
  * Can be specialized if necessary.
+ * @ingroup allocation
  */
 template <typename T>
 class standard_alloc_policy {
@@ -298,6 +301,7 @@ class standard_alloc_policy {
 
 /**
  * Void specialization of the standard allocation policy.
+ * @ingroup allocation
  */
 template <>
 class standard_alloc_policy<void> {

include/libpmemobj++/condition_variable.hpp

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2016-2020, Intel Corporation */
+/* Copyright 2016-2021, Intel Corporation */
 
 /**
  * @file
@@ -29,6 +29,7 @@ namespace obj
  * variable which mimics in behavior the C++11 std::condition_variable. The
  * typical usage example would be:
  * @snippet mutex/mutex.cpp cond_var_example
+ * @ingroup synchronization
  */
 class condition_variable {
 	typedef std::chrono::system_clock clock_type;

include/libpmemobj++/container/array.hpp

@@ -51,6 +51,7 @@ namespace obj
  *
  * @note Since C++20 pmem::obj::array for const types can be initialized only
  * via default constructor. This may change in the future.
+ * @ingroup containers
  */
 template <typename T, std::size_t N>
 struct array {

include/libpmemobj++/container/basic_string.hpp

@@ -41,6 +41,7 @@ namespace obj
  *
  * Simple example of pmem::obj::string usage
  * @snippet string/string.cpp string_example
+ * @ingroup containers
  */
 template <typename CharT, typename Traits = std::char_traits<CharT>>
 class basic_string {

include/libpmemobj++/container/concurrent_hash_map.hpp

@@ -1620,6 +1620,7 @@ operator!=(const hash_map_iterator<Container, M> &i,
  * The example of storing strings without necessity of using transactions would
  * be:
  * @snippet concurrent_hash_map/concurrent_hash_map_string.cpp cmap_string_ex
+ * @ingroup containers
  */
 template <typename Key, typename T, typename Hash, typename KeyEqual,
 	  typename MutexType, typename ScopedLockType>

include/libpmemobj++/container/segment_vector.hpp

@@ -499,6 +499,7 @@ using exponential_size_vector_policy =
  *
  * Example usage:
  * @snippet segment_vector/segment_vector.cpp segment_vector_example
+ * @ingroup containers
  */
 template <typename T, typename Policy = exponential_size_vector_policy<>>
 class segment_vector {

include/libpmemobj++/container/vector.hpp

@@ -36,6 +36,7 @@ namespace obj
 /**
  * pmem::obj::vector - persistent container with std::vector compatible
  * interface.
+ * @ingroup containers
  */
 template <typename T>
 class vector {