From f152ca894898b95de37e7fdd6a5bc4ae9d08d710 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Tue, 7 Aug 2018 10:27:17 -0500 Subject: [PATCH] Fix spacing, Doxygen comments --- src/particle.h | 26 +++++++++++++------------- src/settings.h | 6 +++--- src/string_utils.h | 6 +++--- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/src/particle.h b/src/particle.h index caa54d7de..18244098e 100644 --- a/src/particle.h +++ b/src/particle.h @@ -1,8 +1,8 @@ -#ifndef PARTICLE_H -#define PARTICLE_H +#ifndef OPENMC_PARTICLE_H +#define OPENMC_PARTICLE_H -//! @file particle.h -//! @brief Particle type +//! \file particle.h +//! \brief Particle type #include #include @@ -114,10 +114,10 @@ extern "C" { // //! stores the current phase space attributes of the particle in the //! secondary bank and increments the number of sites in the secondary bank. - //! @param uvw Direction of the secondary particle - //! @param E Energy of the secondary particle in [eV] - //! @param type Particle type - //! @param run_CE Whether continuous-energy data is being used + //! \param uvw Direction of the secondary particle + //! \param E Energy of the secondary particle in [eV] + //! \param type Particle type + //! \param run_CE Whether continuous-energy data is being used void create_secondary(const double* uvw, double E, int type, bool run_CE); //! sets default attributes for a particle @@ -128,13 +128,13 @@ extern "C" { //! initializes a particle from data stored in a source site. The source //! site may have been produced from an external source, from fission, or //! simply as a secondary particle. - //! @param src Source site data - //! @param run_CE Whether continuous-energy data is being used - //! @param energy_bin_avg An array of energy group bin averages + //! \param src Source site data + //! \param run_CE Whether continuous-energy data is being used + //! \param energy_bin_avg An array of energy group bin averages void from_source(const Bank* src, bool run_CE, const double* energy_bin_avg); //! mark a particle as lost and create a particle restart file - //! @param message A warning message to display + //! \param message A warning message to display void mark_as_lost(const char* message); //! create a particle restart HDF5 file @@ -160,4 +160,4 @@ extern "C" { } // namespace openmc -#endif // PARTICLE_H +#endif // OPENMC_PARTICLE_H diff --git a/src/settings.h b/src/settings.h index 0fc272bcd..c203aafde 100644 --- a/src/settings.h +++ b/src/settings.h @@ -1,8 +1,8 @@ #ifndef OPENMC_SETTINGS_H #define OPENMC_SETTINGS_H -//! @file settings.h -//! @brief Settings for OpenMC +//! \file settings.h +//! \brief Settings for OpenMC #include @@ -33,7 +33,7 @@ extern std::string path_source; //============================================================================== //! Read settings from XML file -//! @param[in] root XML node for +//! \param[in] root XML node for //============================================================================== extern "C" void read_settings(pugi::xml_node* root); diff --git a/src/string_utils.h b/src/string_utils.h index d4d3b3173..9af50870d 100644 --- a/src/string_utils.h +++ b/src/string_utils.h @@ -1,5 +1,5 @@ #ifndef OPENMC_STRING_UTILS_H -#define OPNEMC_STRING_UTILS_H +#define OPENMC_STRING_UTILS_H #include #include @@ -34,8 +34,8 @@ split(const std::string& in) inline bool ends_with(const std::string& value, const std::string& ending) { - if (ending.size() > value.size()) return false; - return std::equal(ending.rbegin(), ending.rend(), value.rbegin()); + if (ending.size() > value.size()) return false; + return std::equal(ending.rbegin(), ending.rend(), value.rbegin()); } } // namespace openmc