Added doxygen comments

Author: Federico Rossi

.hdoc.toml

@@ -4,6 +4,8 @@ version = "1.0.0"
 
 # Optional, adding this will enable direct links from the documentation
 # to your source code.
+git_repo_url = "https://github.com/federicorossifr/cppposit/"
+git_default_branch = "main"
 
 [pages]
 homepage="docs/getting_started.md"
@@ -13,6 +15,19 @@ paths = [
     "docs/Tabulation.md"
 ]
 
+[ignore]
+paths = [
+    "include/floats",
+    "include/interface",
+    "include/traits/floattraits.hpp",
+    "include/traits/fixedtraits.hpp",
+    "include/typehelpers.hpp",
+    "include/bithippop.hpp"
+
+]
+
+
+
 [paths]
 compile_commands = "builddir/compile_commands.json"
 output_dir = "cppposit_docs/"

include/backends/fixed.hpp

@@ -20,6 +20,9 @@ namespace posit {
     template <class PT>
 	struct UnpackedPosit;
 
+	/// @brief Fixed Backend for Posit
+	/// @tparam FT FixedTrait class to specify fixed-point number of bits
+	/// @tparam ET ExponentType used to construct the underlying UnpackedPosit
 	template <class FT, class ET>
 	struct BackendFixed
 	{

include/backends/float.hpp

@@ -18,6 +18,8 @@ namespace posit {
     template <class PT>
 	struct UnpackedPosit;
 
+	/// @brief Floating-point like backend
+	/// @tparam B floating-point type (can be float or double)
 	template <class B>
 	struct BackendFloat
 	{

include/backends/hwbaseback.hpp

@@ -11,6 +11,7 @@
 
 namespace posit {
 
+    /// @brief Generalized helper class to mark hardware-based backends
     struct HwBaseBackend {};
 
 }

include/backends/softback.hpp

@@ -33,8 +33,11 @@ enum class NumberType {
   Infinity,
   NaN,
   Zero
-};  /// signed infinity and nan require the extra X bit
+}; 
 
+/// @brief Unpacked backend for full-software posit emulation
+/// @tparam FT Holder type for the fraction
+/// @tparam ET Holder type for the exponent
 template <class FT = uint64_t, class ET = int32_t>
 struct Unpacked {
   using fraction_type = FT;

include/backends/tabback.hpp

@@ -15,6 +15,11 @@ namespace posit {
     template <class T>
 	struct is_posit_backend;
 
+	/// @brief Posit table trait struct: describes characteristic of a tabulated set of operations
+	/// @tparam T holder type
+	/// @tparam n number of Posit bits
+	/// @tparam e number of exponent bits
+	/// @tparam log True if contains logarithmic alternativ to mul and div tables
 	template <class T, int n, int e, bool log>
 	struct PositTableTrait {
 		using type = T;
@@ -23,7 +28,10 @@ namespace posit {
 		using isLogtab = std::integral_constant<bool,log>;
 	};
 
-
+	/// @brief Tabulated Backend for posit
+	/// @tparam PositEmu Posit type used for full-software emulation as a fallback
+	/// @tparam PTable Posit Table class containing the tables used for the operations as static constexpr members
+	/// @tparam PTableTrait Posit Table trait 
 	template <class PTableTrait, class PositEmu, class PTable>
 	struct TabulatedBackend: public HwBaseBackend
 	{

include/backends/unpacked.hpp

@@ -38,12 +38,18 @@ namespace posit {
 		typename PT::POSIT_UTYPE fraction; /// decoded fraciton left aligned with the leading 1
 	};
 
+    /// @brief Helper class to pack and unpack posit from/to backend
+    /// @tparam PT Posit type
+    /// @tparam FT Fraction type
     template <class PT, class FT>
 	struct PositPacker<PT,Unpacked<FT,typename PT::exponenttype> >
 	{
 		using BE = Unpacked<FT,typename PT::exponenttype>;
 		using UP = UnpackedPosit<PT>;
 
+		/// @brief Construct the posit Backend from an UnpackedPosit instance 
+		/// @param up Unpacked Posit instance
+		/// @return Backend type instance
 		static CONSTEXPR14 BE unpacked_to_backend(UP up)
 		{
 			using BE = Unpacked<FT,typename PT::exponenttype>;
@@ -59,6 +65,9 @@ namespace posit {
 			return r;
 		}
 
+		/// @brief Construct an Unpacked posit instance from a Backend instance
+		/// @param b Backend instance
+		/// @return UnpackedPosit
 		static CONSTEXPR14 UP backend_to_unpacked(BE b)
 		{
 			if(b.type == NumberType::Regular)

include/backends/xpositback.hpp

@@ -12,6 +12,9 @@ namespace posit {
     template <class T>
 	struct is_posit_backend;
 
+	/// @brief Demo Backend for ISA-extended Posit backend
+	/// @tparam T holder type
+	/// @tparam PositEmu Posit type used for full-software emulation as fallback
 	template <class T,class PositEmu>
 	struct BackendXPosit: public HwBaseBackend
 	{