From daeaedb503ebc391d5380ef9f66a47b2069ad362 Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (o)" <j.wuttke@fz-juelich.de>
Date: Mon, 29 Jul 2019 14:27:58 +0200
Subject: [PATCH] Update/correct/extend Doxygen comments
---
Core/Fitting/FitObjective.cpp | 2 +-
Core/Lattice/ILatticeOrientation.h | 3 +--
Core/Parametrization/IterationStrategy.cpp | 2 +-
Core/Parametrization/IterationStrategy.h | 3 ++-
Core/Particle/IParticle.h | 2 +-
5 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/Core/Fitting/FitObjective.cpp b/Core/Fitting/FitObjective.cpp
index 7ff2563b0b1..42ad4164af4 100644
--- a/Core/Fitting/FitObjective.cpp
+++ b/Core/Fitting/FitObjective.cpp
@@ -31,7 +31,7 @@ public:
virtual double compute(const std::vector<SimDataPair>& fit_objects, size_t n_pars) const = 0;
};
-// Metric wrapper for back-compaptibility with old scripts
+//! Metric wrapper for back-compaptibility with old scripts
class ChiModuleWrapper : public IMetricWrapper
{
public:
diff --git a/Core/Lattice/ILatticeOrientation.h b/Core/Lattice/ILatticeOrientation.h
index 6ec53738dd9..a6c2e82021f 100644
--- a/Core/Lattice/ILatticeOrientation.h
+++ b/Core/Lattice/ILatticeOrientation.h
@@ -30,8 +30,7 @@ public:
virtual Transform3D transformationMatrix() const=0;
};
-//! MillerIndex represents arbitrary directions in reciprocal space by allowing floating point
-//! index values
+//! A direction in reciprocal space, specified by double-valued indices hkl.
struct BA_CORE_API_ MillerIndex {
MillerIndex(double h_, double k_, double l_);
double h, k, l;
diff --git a/Core/Parametrization/IterationStrategy.cpp b/Core/Parametrization/IterationStrategy.cpp
index 7f63ca414d8..08eda513c9d 100644
--- a/Core/Parametrization/IterationStrategy.cpp
+++ b/Core/Parametrization/IterationStrategy.cpp
@@ -3,7 +3,7 @@
// BornAgain: simulate and fit scattering at grazing incidence
//
//! @file Core/Parametrization/IterationStrategy.cpp
-//! @brief Implements strategies for the class SampleTreeIterator.
+//! @brief Implements class IterationStrategy and children.
//!
//! @homepage http://www.bornagainproject.org
//! @license GNU General Public License v3 or higher (see COPYING)
diff --git a/Core/Parametrization/IterationStrategy.h b/Core/Parametrization/IterationStrategy.h
index 6cb90cb74a0..f3724ee613b 100644
--- a/Core/Parametrization/IterationStrategy.h
+++ b/Core/Parametrization/IterationStrategy.h
@@ -3,7 +3,7 @@
// BornAgain: simulate and fit scattering at grazing incidence
//
//! @file Core/Parametrization/IterationStrategy.h
-//! @brief Defines strategies for the class IterationStrategy.
+//! @brief Defines class IterationStrategy and children.
//!
//! @homepage http://www.bornagainproject.org
//! @license GNU General Public License v3 or higher (see COPYING)
@@ -19,6 +19,7 @@
class IteratorMemento;
+//! Abstract base class of PreorderStrategy and PostorderStrategy, for use in INodeVisitor.
class BA_CORE_API_ IterationStrategy
{
public:
diff --git a/Core/Particle/IParticle.h b/Core/Particle/IParticle.h
index a354c9b8f6a..724e8fba114 100644
--- a/Core/Particle/IParticle.h
+++ b/Core/Particle/IParticle.h
@@ -23,7 +23,7 @@
#include "ZLimits.h"
#include <memory>
-
+//! Vertical extension of a particle, specified by bottom and top z coordinate.
struct ParticleLimits
{
double m_bottom;
--
GitLab