Commit 0fe2eb7a authored by Giovanni La Mura's avatar Giovanni La Mura
Browse files

Add missing inline documentation tags

parent d8739b28

src/include/outputs.h

+10 −1
Original line number Diff line number Diff line
@@ -970,6 +970,15 @@ public: 
// >>> END OF OUTPUT FOR INCLUSION <<<



// >>> OUTPUT FOR SPHERE <<<

/*! \brief Class to collect output information for scattering from a single sphere.

 *

 * The results of the calculation can be saved in different formats.

 * It is therefore convenient to have a proper memory structure that

 * allows for storing the results and flushing them in any of the

 * permitted formats with just one operation. The purpose of the

 * `SphereOutputInfo` class is to provide a wrapper for the output

 * of the spherical particle scattering solver.

 */

class SphereOutputInfo {

protected:

  //! \brief Number of incident azimuth calculations.
@@ -1104,7 +1113,7 @@ public: 
  double *vec_tqsk1;

  //! \brief Vector of sphere average scattering torque along incidence direction (perpendicular polarization).

  double *vec_tqsk2;

  //| \brief Vector of total forward scattering amplitudes.

  //! \brief Vector of total forward scattering amplitudes.

  dcomplex *vec_fsat;

  //! \brief Vector of total QSCHU.

  double *vec_qschut;

src/inclusion/inclusion.cpp

+2 −2
Original line number Diff line number Diff line
@@ -118,7 +118,7 @@ using namespace std; 
 *  \param gconf: `GeometryConfiguration *` Pointer to a `GeometryConfiguration` object.

 *  \param sa: `ScatteringAngles *` Pointer to a `ScatteringAngles` object.

 *  \param cid: `InclusionIterationData *` Pointer to an `InclusionIterationData` object.

 *  \param oi: `InclusionOutputInfo *` Pointer to an `InclusionOutputInfo` object.

 *  \param output: `InclusionOutputInfo *` Pointer to an `InclusionOutputInfo` object.

 *  \param output_path: `const string &` Path to the output directory.

 *  \param vtppoanp: `VirtualBinaryFile *` Pointer to a `VirtualBinaryFile` object.

 */

src/scripts/model_maker.py

+7 −3
Original line number Diff line number Diff line
@@ -15,10 +15,14 @@ 
#   A copy of the GNU General Public License is distributed along with

#   this program in the COPYING file. If not, see: <https://www.gnu.org/licenses/>.



## @package pycompare

#  \brief Script to build models from YAML configuration files

## @package model_maker

#  \brief Script to build models from YAML configuration files.

#

#  Script to assist in the creation of model input files starting

#  from a YAML descriptor.

#

#  The script requires python3.



import numpy as np

import yaml



from pathlib import PurePath

src/scripts/pycompare.py

+1 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ 
#   this program in the COPYING file. If not, see: <https://www.gnu.org/licenses/>.



## @package pycompare

#  \brief Script to perform output consistency tests

#  \brief Script to perform output consistency tests.

#

#  Comparing the numeric output can be rendered hard by the amount of information

#  contained in a typical output file and the necessity to determine whether a