Imprive c2c plan docs

Doxyfile

@@ -54,7 +54,7 @@ PROJECT_NUMBER         = 0.1.0
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          =
+PROJECT_BRIEF          = "Audio DSP library"
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
@@ -957,7 +957,7 @@ INPUT_FILE_ENCODING    =
 # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
 # *.vhdl, *.ucf, *.qsf and *.ice.
 
-FILE_PATTERNS          = *.hpp *.md *.py
+FILE_PATTERNS          = *.hpp *.md
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.

src/neo/fft/fallback/fallback_dft_plan.hpp

@@ -84,7 +84,7 @@ struct fallback_dft_plan
     size_type _size;
     fft_plan<Complex> _plan{
         fft::from_order,
-        fft::next_order(_size* size_type(2) + size_type(1)),
+        fft::next_order(size() * size_type(2) + size_type(1)),
     };
 
     stdex::mdarray<Complex, stdex::dextents<std::size_t, 1>> _wf{size()};

src/neo/fft/reference/bitrevorder.hpp

@@ -14,6 +14,7 @@
 
 namespace neo::fft {
 
+/// Reorder input using bit reversal permutation.
 struct bitrevorder_plan
 {
     explicit bitrevorder_plan(std::size_t order) : _table{make(std::size_t(1) << order)} {}

src/neo/fft/reference/c2c_dif3_plan.hpp

@@ -12,7 +12,8 @@
 
 namespace neo::fft {
 
-/// https://github.com/scientificgo/fft/blob/master/radix3.go
+/// \brief C2C Cooley–Tukey Radix-3 DIF
+/// \details https://github.com/scientificgo/fft/blob/master/radix3.go
 template<complex Complex>
 struct c2c_dif3_plan
 {

src/neo/fft/reference/c2c_dif5_plan.hpp

@@ -12,7 +12,8 @@
 
 namespace neo::fft {
 
-/// https://github.com/scientificgo/fft/blob/master/radix5.go
+/// \brief C2C Cooley–Tukey Radix-5 DIF
+/// \details https://github.com/scientificgo/fft/blob/master/radix5.go
 template<complex Complex>
 struct c2c_dif5_plan
 {

src/neo/fft/reference/c2c_dit2_plan.hpp

@@ -16,6 +16,7 @@
 
 namespace neo::fft {
 
+/// \brief C2C Cooley–Tukey Radix-2 DIT
 template<typename Complex, typename Kernel = kernel::c2c_dit2_v3>
 struct c2c_dit2_plan
 {

src/neo/fft/reference/c2c_dit4_plan.hpp

@@ -12,6 +12,7 @@
 
 namespace neo::fft {
 
+/// \brief C2C Cooley–Tukey Radix-4
 template<complex Complex, bool UseDIT>
 struct c2c_radix4_plan
 {
@@ -203,9 +204,11 @@ struct c2c_radix4_plan
     stdex::mdarray<Complex, stdex::dextents<std::size_t, 2>> _w{make_twiddle_lut(size())};
 };
 
+/// \brief C2C Cooley–Tukey Radix-4 DIT
 template<typename Complex>
 using c2c_dit4_plan = c2c_radix4_plan<Complex, true>;
 
+/// \brief C2C Cooley–Tukey Radix-4 DIF
 template<typename Complex>
 using c2c_dif4_plan = c2c_radix4_plan<Complex, false>;
 

src/neo/fft/reference/c2c_stockham_dif2_plan.hpp

@@ -16,7 +16,8 @@
 
 namespace neo::fft {
 
-/// http://wwwa.pikara.ne.jp/okojisan/otfft-en/stockham2.html
+/// \brief C2C Stockham Radix-2 DIF (Recursive)
+/// \details http://wwwa.pikara.ne.jp/okojisan/otfft-en/stockham2.html
 template<complex Complex>
 struct c2c_stockham_dif2r_plan
 {
@@ -115,10 +116,12 @@ struct c2c_stockham_dif2r_plan
     stdex::mdarray<Complex, stdex::dextents<std::size_t, 1>> _work{size()};
 };
 
-/// Chapter 2.5
-/// Fast Fourier Transform Algorithms for Parallel Computers
-/// Daisuke Takahashi (2019)
-/// ISBN 978-981-13-9964-0
+/// \brief C2C Stockham Radix-2 DIF (Iterative)
+///
+/// Chapter 2.5 \n
+/// Fast Fourier Transform Algorithms for Parallel Computers \n
+/// Daisuke Takahashi (2019) \n
+/// ISBN 978-981-13-9964-0 \n
 template<complex Complex>
 struct c2c_stockham_dif2i_plan
 {

src/neo/fft/reference/c2c_stockham_dif3_plan.hpp

@@ -13,10 +13,12 @@
 
 namespace neo::fft {
 
-/// Chapter 3.2
-/// Fast Fourier Transform Algorithms for Parallel Computers
-/// Daisuke Takahashi (2019)
-/// ISBN 978-981-13-9964-0
+/// \brief C2C Stockham Radix-3 DIF
+///
+/// Chapter 3.2 \n
+/// Fast Fourier Transform Algorithms for Parallel Computers \n
+/// Daisuke Takahashi (2019) \n
+/// ISBN 978-981-13-9964-0 \n
 template<complex Complex>
 struct c2c_stockham_dif3_plan
 {

src/neo/fft/reference/c2c_stockham_dif4_plan.hpp

@@ -13,10 +13,12 @@
 
 namespace neo::fft {
 
-/// Chapter 3.3
-/// Fast Fourier Transform Algorithms for Parallel Computers
-/// Daisuke Takahashi (2019)
-/// ISBN 978-981-13-9964-0
+/// \brief C2C Stockham Radix-4 DIF
+///
+/// Chapter 3.3 \n
+/// Fast Fourier Transform Algorithms for Parallel Computers \n
+/// Daisuke Takahashi (2019) \n
+/// ISBN 978-981-13-9964-0 \n
 template<complex Complex>
 struct c2c_stockham_dif4_plan
 {

src/neo/fft/reference/c2c_stockham_dif5_plan.hpp

@@ -13,10 +13,12 @@
 
 namespace neo::fft {
 
-/// Chapter 3.4
-/// Fast Fourier Transform Algorithms for Parallel Computers
-/// Daisuke Takahashi (2019)
-/// ISBN 978-981-13-9964-0
+/// \brief C2C Stockham Radix-5 DIF
+///
+/// Chapter 3.4 \n
+/// Fast Fourier Transform Algorithms for Parallel Computers \n
+/// Daisuke Takahashi (2019) \n
+/// ISBN 978-981-13-9964-0 \n
 template<complex Complex>
 struct c2c_stockham_dif5_plan
 {

src/neo/fft/reference/c2c_stockham_dif8_plan.hpp

@@ -13,10 +13,12 @@
 
 namespace neo::fft {
 
-/// Chapter 3.5
-/// Fast Fourier Transform Algorithms for Parallel Computers
-/// Daisuke Takahashi (2019)
-/// ISBN 978-981-13-9964-0
+/// \brief C2C Stockham Radix-8 DIF
+///
+/// Chapter 3.5 \n
+/// Fast Fourier Transform Algorithms for Parallel Computers \n
+/// Daisuke Takahashi (2019) \n
+/// ISBN 978-981-13-9964-0 \n
 template<complex Complex>
 struct c2c_stockham_dif8_plan
 {

src/neo/fft/reference/c2c_stockham_dit4_plan.hpp

@@ -13,6 +13,7 @@
 
 namespace neo::fft {
 
+/// \brief C2C Stockham Radix-4 DIT
 template<complex Complex>
 struct c2c_stockham_dit4_plan
 {