docu: restructering of documentation

.reuse/dep5

@@ -15,6 +15,10 @@ Files: doc/Figures/*.jpg
 Copyright: 2024 The YAC Authors
 License: CC-BY-4.0
 
+Files: doc/src/*.idox
+Copyright: 2024 The YAC Authors
+License: CC-BY-4.0
+
 Files: input/*.txt
 Copyright: 2024 The YAC Authors
 License: CC-BY-4.0

doc/Doxyfile

@@ -980,7 +980,7 @@ INPUT_FILE_ENCODING    =
 # *.cpp, *.cppm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl,
 # *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php,
 # *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be
-# provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
+# provided as doxygen C comment), *.idox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
 # *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
 
 FILE_PATTERNS          = *.c \
@@ -991,6 +991,7 @@ FILE_PATTERNS          = *.c \
                          *.h \
                          *.inc \
                          *.dox \
+                         *.idox \
                          *.pyx \
                          *.py
 

doc/src/components.dox

@@ -5,7 +5,7 @@
 /**
  * \page yac_lib_core YAC Core library
 
-\include{doc,prefix=yac_lib_core_} doc/src/lib_core.dox
+\include{doc,prefix=yac_lib_core_} doc/src/lib_core.idox
 
 <hr>
 
@@ -19,7 +19,7 @@
 /**
  * \page yac_lib_mci YAC MCI library
 
-\include{doc,prefix=yac_lib_mci_} doc/src/lib_mci.dox
+\include{doc,prefix=yac_lib_mci_} doc/src/lib_mci.idox
 
 <hr>
 
@@ -37,7 +37,7 @@
 /**
  * \page yac_lib_utils YAC Utility libary
 
-\include{doc,prefix=yac_lib_utils_} doc/src/lib_utils.dox
+\include{doc,prefix=yac_lib_utils_} doc/src/lib_utils.idox
 
 <hr>
 
@@ -53,15 +53,15 @@ YAC contains three libraries.
 
 \section yac_libs_core YAC Core libary
 
-\include{doc,raise=1,prefix=yac_libs_core_} doc/src/lib_core.dox
+\include{doc,raise=1,prefix=yac_libs_core_} doc/src/lib_core.idox
 
 \section yac_libs_mci YAC MCI library
 
-\include{doc,raise=1,prefix=yac_libs_mci_} doc/src/lib_mci.dox
+\include{doc,raise=1,prefix=yac_libs_mci_} doc/src/lib_mci.idox
 
 \section yac_libs_utils YAC Utility libary
 
-\include{doc,raise=1,prefix=yac_libs_utils_} doc/src/lib_utils.dox
+\include{doc,raise=1,prefix=yac_libs_utils_} doc/src/lib_utils.idox
 
 <hr>