Fix various Doxygen issues (#4633)

* Fix code format in Doxygen.
* Prefer \code to \verbatim because of syntax highlighting.
* Fix some warnings.
* Update doxygen.conf.
* Use the new log.
* Fail CI if there Doxygen warnings.

Author: WeiqunZhang

Docs/Doxygen/amrex_logo_tiny.png

@@ -396,7 +396,7 @@ public:
     * \param result_type
     * \param nvar_derive
     * \param der_func
-    * \param box_map
+    * \param bx_map
     * \param interp
     */
     void add (const std::string&      name,
@@ -444,11 +444,11 @@ public:
     * \brief Adds another entry to the registry.
     *
     * \param name
-    * \param result_type
+    * \param res_typ
     * \param nvar_derive
-    * \param var_names
+    * \param vars
     * \param der_func
-    * \param box_map
+    * \param bx_map
     * \param interp
     */
     void add (const std::string&      name,
@@ -489,8 +489,8 @@ public:
     * \param name
     * \param d_list
     * \param state_indx
-    * \param start_comp
-    * \param ncomp
+    * \param s_comp
+    * \param n_comp
     */
     void addComponent (const std::string&    name,
                        const DescriptorList& d_list,

Docs/Doxygen/doxygen.conf

@@ -163,7 +163,7 @@ public:
     /**
     * \brief Sets time of old and new data.
     *
-    * \param t_new
+    * \param time
     * \param dt_old
     * \param dt_new
     */
@@ -173,15 +173,11 @@ public:
 
     /**
     * \brief Sets time of old data.
-    *
-    * \param t_old
     */
     void setOldTimeLevel (Real time);
 
     /**
     * \brief Sets time of new data.
-    *
-    * \param t_new
     */
     void setNewTimeLevel (Real time);
 
@@ -261,9 +257,9 @@ public:
     * \param p_domain
     * \param grds
     * \param dm
-    * \param factroy
+    * \param factory
     * \param d
-    * \param restart_file
+    * \param chkfile
     */
     void restart (std::istream&          is,
                   const Box&             p_domain,

Docs/Doxygen/resize_AMReX_logo.png

@@ -206,7 +206,7 @@ public:
     * \param bc
     * \param func
     * \param interp
-    * \param primary_or_secondary
+    * \param a_primary
     * \param groupsize
     */
     void setComponent (int                comp,

Src/Amr/AMReX_Derive.H

@@ -22,25 +22,6 @@ extern "C"
 
     /**
     * \brief Type of extern "C" function called by ErrorRec to do tagging of cells for refinement.
-    *
-    * \param tag
-    * \param tlo
-    * \param thi
-    * \param tagval
-    * \param clearval
-    * \param data
-    * \param data_lo
-    * \param data_hi
-    * \param lo
-    * \param hi
-    * \param nvar
-    * \param domain_lo
-    * \param domain_hi
-    * \param dx
-    * \param xlo
-    * \param prob_lo
-    * \param time
-    * \param level
     */
     using ErrorFuncDefault = void (*)(int* tag, AMREX_ARLIM_P(tlo), AMREX_ARLIM_P(thi),
                                       const int* tagval, const int* clearval,
@@ -156,25 +137,6 @@ public:
 
         /**
         * \brief Tag cells using "regular" function.
-        *
-        * \param tag
-        * \param tlo
-        * \param thi
-        * \param tagval
-        * \param clearval
-        * \param data
-        * \param data_lo
-        * \param data_hi
-        * \param lo
-        * \param hi
-        * \param nvar
-        * \param domain_lo
-        * \param domain_hi
-        * \param dx
-        * \param xlo
-        * \param prob_lo
-        * \param time
-        * \param level
         */
         virtual void operator () (int* tag, AMREX_ARLIM_P(tlo), AMREX_ARLIM_P(thi),
                                   const int* tagval, const int* clearval,
@@ -194,8 +156,8 @@ public:
         * \param tagval
         * \param clearval
         * \param data
-        * \param data_lo
-        * \param data_hi
+        * \param dlo
+        * \param dhi
         * \param lo
         * \param hi
         * \param nvar
@@ -255,23 +217,6 @@ public:
 
         /**
         * \brief Tag cells cells using "v2" interface
-        *
-        * \param tag
-        * \param tlo
-        * \param thi
-        * \param tagval
-        * \param clearval
-        * \param data
-        * \param data_lo
-        * \param data_hi
-        * \param lo
-        * \param hi
-        * \param nvar
-        * \param domain_lo
-        * \param domain_hi
-        * \param dx
-        * \param level
-        * \param avg
         */
         virtual void operator () (int* tag, AMREX_ARLIM_P(tlo), AMREX_ARLIM_P(thi),
                                   const int* tagval, const int* clearval,

Src/Amr/AMReX_StateData.H

@@ -105,10 +105,10 @@ public:
      * \param nghost      number of ghost cells to fill. This must be <= what's
      *                    provided to the constructor
      * \param time        time associated with the destination
-     * \param crse_data   coarse level data
-     * \param crse_time   time associated with the coarse data
-     * \param fine_data   fine level data
-     * \param fine_time   time associated with the fine data
+     * \param cmf         coarse level data
+     * \param ct          time associated with the coarse data
+     * \param fmf         fine level data
+     * \param ft          time associated with the fine data
      * \param scomp       starting component of the source
      * \param dcomp       starting component of the destination
      * \param ncomp       the number of components to fill
@@ -140,8 +140,8 @@ public:
      * \param nghost      number of ghost cells to fill. This must be <= what's
      *                    provided to the constructor
      * \param time        time associated with the destination
-     * \param crse_data   coarse level data
-     * \param crse_time   time associated with the coarse data
+     * \param cmf         coarse level data
+     * \param ct          time associated with the coarse data
      * \param scomp       starting component of the source
      * \param dcomp       starting component of the destination
      * \param ncomp       the number of components to fill
@@ -187,6 +187,8 @@ public:
      *                  denoting the first and second substep, respectively.
      * \param ncycle    number of subcyling steps.  It's usually 2 or 4.
      *                  Without subcycling, this will be 1.
+     * \param mf        destination MF
+     * \param time      time associated with the coarse data
      * \param cbc       filling physical boundary on coarse level
      * \param fbc       filling physical boundary on fine level
      * \param bcs       physical BC types

Src/Amr/AMReX_StateDescriptor.H

@@ -2,6 +2,8 @@
 #define AMREX_FLUXREG_1D_C_H_
 #include <AMReX_Config.H>
 
+#if (AMREX_SPACEDIM == 1)
+
 #include <AMReX_FArrayBox.H>
 
 namespace amrex {
@@ -91,3 +93,5 @@ fluxreg_reflux (Box const& bx, Array4<Real> const& s, const int scomp,
 }
 
 #endif
+
+#endif

Src/AmrCore/AMReX_ErrorList.H

@@ -2,6 +2,8 @@
 #define AMREX_FLUXREG_2D_C_H_
 #include <AMReX_Config.H>
 
+#if (AMREX_SPACEDIM == 2)
+
 #include <AMReX_FArrayBox.H>
 
 namespace amrex {
@@ -171,3 +173,5 @@ fluxreg_reflux (Box const& bx, Array4<Real> const& s, const int scomp,
 }
 
 #endif
+
+#endif