Missing documentation and more doc

Author: Nxirda

CMakeLists.txt

@@ -4,7 +4,7 @@
 ##  SPDX-License-Identifier: BSL-1.0
 ##======================================================================================================================
 cmake_minimum_required(VERSION 3.22)
-project(kumi LANGUAGES CXX)
+project(KUMI LANGUAGES CXX)
 
 ##======================================================================================================================
 option( KUMI_BUILD_TEST             "Build tests using Kumi headers"            ON  )

doc/index.hpp

@@ -105,7 +105,7 @@
 //!
 //! This library is licensed under the [Boost Software License](https://opensource.org/licenses/BSL):
 //!
-//! ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~none
+//! ```text 
 //! Copyright : KUMI Project Contributors
 //! 
 //! Boost Software License - Version 1.0 - August 17th, 2003
@@ -131,6 +131,6 @@
 //! FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 //! ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 //! DEALINGS IN THE SOFTWARE.
-//! ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+//! ``` 
 //!
 //==================================================================================================

doc/layout.xml

@@ -10,8 +10,8 @@
     </tab>
     <tab type="usergroup" visible="yes"   title="Reference Documentation">
       <tab type="usergroup" visible="yes"   title="Types">
-        <tab type="user" url="@ref product_types"   title="Product types"/>
-        <tab type="user" url="@ref record_types"  title="Record Types"/>
+        <tab type="user" url="@ref tuple"   title="Product types"/>
+        <tab type="user" url="@ref record"  title="Record Types"/>
       </tab>
       <tab type="usergroup" visible="yes" title="Algorithms">
         <tab type="user" url="@ref transforms"  title="Transformations"/>

doc/licence.md

@@ -3,7 +3,7 @@ Licence {#licence}
 
 This library is licensed under the [Boost Software License](http://opensource.org/licenses/BSL):
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~none
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Copyright : KUMI Project Contributors
 
 Boost Software License - Version 1.0 - August 17th, 2003

include/kumi/algorithm.hpp

@@ -13,19 +13,16 @@ namespace kumi
   //! @defgroup algorithm Product Type Algorithms
   //! @brief    Algorithms for manipulating Product types
   //!
-  //! @addtogroup algorithm
   //! @{
   //!   @defgroup transforms Product Type Transformations
   //!   @brief Algorithms applying transformation to product types
-  //! 
-  //!   @addtogroup transforms
-  //!   @{  
+  //!   @{
   //!     @defgroup tuple_transforms Tuple Type Specific Transformations
   //!     @brief Algorithms applying transformation to tuples
-  //!   
+  //!
   //!     @defgroup record_transforms Record Type Specific Transformations
-  //!     @brief Algorithms applying transformation to records  
-  //!   @}   
+  //!     @brief Algorithms applying transformation to records
+  //!   @}
   //!
   //!   @defgroup queries Product Type Queries
   //!   @brief    Algorithms querying properties from product types

include/kumi/algorithm/cartesian_product.hpp

@@ -37,9 +37,9 @@ namespace kumi
   }
 
   //====================================================================================================================
-  //! @ingroup generators
+  //! @ingroup    generators
   //! @brief      Return the Cartesian Product of all elements of its arguments product types
-  //! @param  ts  Product types to process
+  //! @param ts   Product types to process
   //! @return     A tuple containing all the product types built from all combination of all ts'
   //!             elements
   //!

include/kumi/algorithm/cast.hpp

@@ -30,8 +30,8 @@ namespace kumi
   }
 
   //====================================================================================================================
-  //! @ingroup algorithms
-  //! @brief Converts a product_type<Ts...> to an instance of a product_type<Target...>
+  //! @ingroup  generators
+  //! @brief    Converts a product_type<Ts...> to an instance of a product_type<Target...>
   //!
   //! @tparam Target destination type to associate to each member of the product type `t`
   //! @param  t Product type to convert

include/kumi/algorithm/cat.hpp

@@ -10,8 +10,8 @@
 namespace kumi
 {
   //====================================================================================================================
-  //! @ingroup generators
-  //! @brief Concatenates product types in a single one
+  //! @ingroup  generators
+  //! @brief    Concatenates product types in a single one
   //!
   //! @param ts Product types to concatenate
   //! @return   A product type made of all element of all input product types in order.

include/kumi/algorithm/contains.hpp

@@ -16,7 +16,7 @@ namespace kumi
   }
 
   //====================================================================================================================
-  //! @ingroup algorithm
+  //! @ingroup queries
   //! @brief Checks if a product type contains a given identifier
   //!
   //! @param t the product type to inspect.
@@ -27,25 +27,25 @@ namespace kumi
   //! @include doc/tuple/algo/contains.cpp
   //! @include doc/record/algo/contains.cpp
   //====================================================================================================================
-  template<concepts::product_type T, concepts::identifier I>
-  KUMI_ABI constexpr bool contains([[maybe_unused]] T&& t, [[maybe_unused]] I const& id) noexcept
+  template<concepts::product_type T, concepts::identifier ID>
+  KUMI_ABI constexpr bool contains([[maybe_unused]] T&& t, [[maybe_unused]] ID const& id) noexcept
   {
     if constexpr (concepts::sized_product_type<T, 0>) return false;
     else if constexpr (concepts::record_type<T>)
       return []<std::size_t... I>(std::index_sequence<I...>) {
-        return _::can_get_field_by_value<std::remove_cvref_t<K>, element_t<I, T>...>;
+        return _::can_get_field_by_value<std::remove_cvref_t<ID>, element_t<I, T>...>;
       }(std::make_index_sequence<size_v<T>>{});
     else
       return []<std::size_t... I>(std::index_sequence<I...>) {
-        if constexpr (((concepts::field<element_t<I, T>> && std::invocable<element_t<I, T>, std::remove_cvref_t<K>>) ||
+        if constexpr (((concepts::field<element_t<I, T>> && std::invocable<element_t<I, T>, std::remove_cvref_t<ID>>) ||
                        ...))
           return true;
         else return false;
       }(std::make_index_sequence<size_v<T>>{});
   }
 
   //====================================================================================================================
-  //! @ingroup algorithm
+  //! @ingroup queries
   //! @brief Checks if a product type contains at least one of many identifiers
   //!
   //! @param t the product type to inspect.
@@ -60,12 +60,12 @@ namespace kumi
   KUMI_ABI constexpr bool contains_any(T&& t, Is const&... ids) noexcept
   {
     if constexpr (concepts::sized_product_type<T, 0>) return false;
-    else if constexpr (sizeof...(Ks) == 0) return false;
-    else return (contains(KUMI_FWD(t), ks) || ...);
+    else if constexpr (sizeof...(Is) == 0) return false;
+    else return (contains(KUMI_FWD(t), ids) || ...);
   }
 
   //==================================================================================================================
-  //! @ingroup algorithm
+  //! @ingroup queries
   //! @brief Checks if a product type contains fields based only on selected identifiers
   //!
   //! @param t the product type to inspect.
@@ -80,16 +80,16 @@ namespace kumi
   KUMI_ABI constexpr bool contains_only([[maybe_unused]] T&& t, [[maybe_unused]] Is const&... ids) noexcept
   {
     if constexpr (concepts::sized_product_type<T, 0>) return false;
-    else if constexpr (sizeof...(Ks) == 0) return false;
-    else if constexpr (sizeof...(Ks) < size_v<T>) return false;
+    else if constexpr (sizeof...(Is) == 0) return false;
+    else if constexpr (sizeof...(Is) < size_v<T>) return false;
     else
       return [&]<std::size_t... I>(std::index_sequence<I...>) {
-        return (_::contains<element_t<I, T>, Ks...> && ...);
+        return (_::contains<element_t<I, T>, Is...> && ...);
       }(std::make_index_sequence<size_v<T>>{});
   }
 
   //==================================================================================================================
-  //! @ingroup algorithm
+  //! @ingroup queries
   //! @brief Checks if a product type contains no fields based on any of the selected identifiers
   //!
   //! @param t the product type to inspect.
@@ -103,6 +103,6 @@ namespace kumi
   template<concepts::product_type T, concepts::identifier... Is>
   KUMI_ABI constexpr bool contains_none(T&& t, Is const&... ids) noexcept
   {
-    return !contains_any(KUMI_FWD(t), ks...);
+    return !contains_any(KUMI_FWD(t), ids...);
   }
 }

include/kumi/product_types.hpp

@@ -13,12 +13,12 @@ namespace kumi
   //! @defgroup types Kumi Types
   //! @brief    Class definition and functions on kumi types
   //!
-  //! @defgroup product_types Product Types and associated Functions
-  //! @ingroup types
+  //! @defgroup tuple Product Types and associated Functions
+  //! @ingroup  types
   //! @brief    Definition for kumi defined product type classes and functions
   //!
-  //! @defgroup record_types Record Types and associated Functions
-  //! @ingroup types
+  //! @defgroup record Record Types and associated Functions
+  //! @ingroup  types
   //! @brief    Definition for kumi defined record type classes and functions
   //================================================================================================
 }