diff --git a/Doxyfile b/Doxyfile index 71493be4e..c8aa9e562 100644 --- a/Doxyfile +++ b/Doxyfile @@ -699,7 +699,7 @@ WARNINGS = YES # will automatically be disabled. # The default value is: YES. -WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = NO # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters diff --git a/src/Numerics/Containers.h b/src/Numerics/Containers.h index adfd30031..b32dd8d97 100644 --- a/src/Numerics/Containers.h +++ b/src/Numerics/Containers.h @@ -11,7 +11,7 @@ // Intel Corp. //////////////////////////////////////////////////////////////////////////////// // -*- C++ -*- -/** @file Container.h +/** @file Containers.h * * Master header to support SoA containers */ diff --git a/src/Numerics/DeterminantOperators.h b/src/Numerics/DeterminantOperators.h index fcca9814f..1453433f9 100644 --- a/src/Numerics/DeterminantOperators.h +++ b/src/Numerics/DeterminantOperators.h @@ -21,7 +21,7 @@ // University of Illinois at Urbana-Champaign ////////////////////////////////////////////////////////////////////////////////////// -/** @file DeterminantOperator.h +/** @file DeterminantOperators.h * @brief Define determinant operators */ #ifndef OHMMS_NUMERIC_DETERMINANT_H diff --git a/src/Numerics/PosTransformer.h b/src/Numerics/PosTransformer.h index c1c29b5d1..104e95995 100644 --- a/src/Numerics/PosTransformer.h +++ b/src/Numerics/PosTransformer.h @@ -11,7 +11,7 @@ // Intel Corp. //////////////////////////////////////////////////////////////////////////////// // -*- C++ -*- -/** @file VectorOperators.h +/** @file PosTransformer.h * @brief Support funtions to handle position type data manged by soa */ #ifndef QMCPLUSPLUS_SOA_FAST_PARTICLE_OPERATORS_H diff --git a/src/Numerics/Spline2/MultiBspline.hpp b/src/Numerics/Spline2/MultiBspline.hpp index 92efe49f9..a3e6f5516 100644 --- a/src/Numerics/Spline2/MultiBspline.hpp +++ b/src/Numerics/Spline2/MultiBspline.hpp @@ -16,6 +16,8 @@ /**@file MultiBspline.hpp * * Master header file to define MultiBspline + * + * Contains 3D spline evaluation routines. */ #ifndef QMCPLUSPLUS_MULTIEINSPLINE_COMMON_HPP #define QMCPLUSPLUS_MULTIEINSPLINE_COMMON_HPP @@ -30,7 +32,7 @@ namespace qmcplusplus template struct MultiBspline { - /// define the einsplie object type + /// define the einspline object type using spliner_type = typename bspline_traits::SplineType; MultiBspline() {} diff --git a/src/Numerics/Spline2/MultiBsplineData.cpp b/src/Numerics/Spline2/MultiBsplineData.cpp index 087bcd0b7..14d4855f0 100644 --- a/src/Numerics/Spline2/MultiBsplineData.cpp +++ b/src/Numerics/Spline2/MultiBsplineData.cpp @@ -9,7 +9,7 @@ // File created by: Jeongnim Kim, jeongnim.kim@intel.com, Intel Corp. //////////////////////////////////////////////////////////////////////////////// // -*- C++ -*- -/**@file MultiBspline.cpp +/**@file MultiBsplineData.cpp * * Initialize the static data for float and double */ diff --git a/src/Numerics/Spline2/bspline_allocator.cpp b/src/Numerics/Spline2/bspline_allocator.cpp index 692384c04..bc2da4036 100644 --- a/src/Numerics/Spline2/bspline_allocator.cpp +++ b/src/Numerics/Spline2/bspline_allocator.cpp @@ -9,7 +9,7 @@ // File created by: Jeongnim Kim, jeongnim.kim@intel.com, Intel Corp. //////////////////////////////////////////////////////////////////////////////// // -*- C++ -*- -/** @file einspline_allocator.cpp +/** @file bspline_allocator.cpp * @brief Implementation of einspline::Allocator member functions * * Allocator::Policy is not defined precisely yet but is intended to select diff --git a/src/Numerics/Spline2/bspline_traits.hpp b/src/Numerics/Spline2/bspline_traits.hpp index 2d9e11053..94e816b85 100644 --- a/src/Numerics/Spline2/bspline_traits.hpp +++ b/src/Numerics/Spline2/bspline_traits.hpp @@ -9,7 +9,7 @@ // File created by: Jeongnim Kim, jeongnim.kim@intel.com, Intel Corp. //////////////////////////////////////////////////////////////////////////////// // -*- C++ -*- -/** @file bspline_traits.h +/** @file bspline_traits.hpp * * extend spline/bspline_traints by introducing * bspline_traits with only speciliazation with 3D diff --git a/src/Numerics/readme_soa.md b/src/Numerics/readme_soa.md index 27d4a45b0..7d17b326f 100644 --- a/src/Numerics/readme_soa.md +++ b/src/Numerics/readme_soa.md @@ -37,5 +37,5 @@ Access operators to each compoenent are provided. \code H.data(int i, int j); //return the starting address of (i,j) component -\endode +\endcode diff --git a/src/Particle/Lattice/ParticleBConds.h b/src/Particle/Lattice/ParticleBConds.h index cd3182527..e6e7bd08e 100644 --- a/src/Particle/Lattice/ParticleBConds.h +++ b/src/Particle/Lattice/ParticleBConds.h @@ -33,7 +33,7 @@ namespace qmcplusplus * * @tparam T real data type * @tparam D physical dimension - * @tparm SC supercell type + * @tparam SC supercell type * * Default method for any dimension with OPEN boundary condition. * \htmlonly diff --git a/src/Particle/ParticleSet.cpp b/src/Particle/ParticleSet.cpp index 02fec493e..1666924d0 100644 --- a/src/Particle/ParticleSet.cpp +++ b/src/Particle/ParticleSet.cpp @@ -34,6 +34,10 @@ #include "Particle/DistanceTable.h" #include "Utilities/RandomGenerator.h" +/** @file ParticleSet.cpp + * @brief Particle positions and related data + */ + //#define PACK_DISTANCETABLES namespace qmcplusplus diff --git a/src/Particle/ParticleSet.h b/src/Particle/ParticleSet.h index f2ad071e4..ec2eba88a 100644 --- a/src/Particle/ParticleSet.h +++ b/src/Particle/ParticleSet.h @@ -24,6 +24,10 @@ // University of Illinois at Urbana-Champaign //////////////////////////////////////////////////////////////////////////////// +/** @file ParticleSet.h + * @brief Particle positions and related data + */ + #ifndef QMCPLUSPLUS_PARTICLESET_H #define QMCPLUSPLUS_PARTICLESET_H @@ -74,9 +78,9 @@ template struct MCDataType class ParticleSet : public QMCTraits, public PtclOnLatticeTraits { public: - ///@typedef walker type + /// walker type typedef Walker Walker_t; - ///@typedef buffer type for a serialized buffer + /// buffer type for a serialized buffer typedef Walker_t::Buffer_t Buffer_t; /// the name of the particle set. diff --git a/src/QMCWaveFunctions/WaveFunction.cpp b/src/QMCWaveFunctions/WaveFunction.cpp index 51e6b38d2..d4f602e27 100644 --- a/src/QMCWaveFunctions/WaveFunction.cpp +++ b/src/QMCWaveFunctions/WaveFunction.cpp @@ -14,7 +14,7 @@ #include /*! - * @file SoAWaveFunction.cpp + * @file WaveFunction.cpp @brief Wavefunction based on Structure of Arrays (SoA) storage */ diff --git a/src/QMCWaveFunctions/WaveFunctionComponentBase.h b/src/QMCWaveFunctions/WaveFunctionComponentBase.h index 4f2af23c5..e36610825 100644 --- a/src/QMCWaveFunctions/WaveFunctionComponentBase.h +++ b/src/QMCWaveFunctions/WaveFunctionComponentBase.h @@ -29,7 +29,7 @@ #include "Particle/ParticleSet.h" #include "Particle/DistanceTableData.h" -/**@file wavefunctioncomponentbase.h +/**@file WaveFunctionComponentBase.h *@brief Declaration of WaveFunctionComponentBase */ namespace qmcplusplus diff --git a/src/QMCWaveFunctions/WaveFunctionRef.cpp b/src/QMCWaveFunctions/WaveFunctionRef.cpp index f1428c807..a0e9e9f41 100644 --- a/src/QMCWaveFunctions/WaveFunctionRef.cpp +++ b/src/QMCWaveFunctions/WaveFunctionRef.cpp @@ -18,6 +18,10 @@ * @brief Wavefunction based on reference implemenation */ +/*! + * Namespace containing reference implementation. + */ + namespace miniqmcreference { using namespace qmcplusplus;