Commit b43cb473 authored by Giovanni La Mura's avatar Giovanni La Mura
Browse files

Remove TBD markers from header files inline documentation

parent 5ff3b2f3

src/include/Commons.h

+20 −20
Original line number Diff line number Diff line
@@ -218,9 +218,9 @@ public: 
  int *iog;

  //! \brief Vector of number of layers in sphere type.

  int *nshl;

  //! \brief TBD

  //! \brief ANNOTATION: Square inverted coefficients.

  dcomplex *ris;

  //! \brief TBD

  //! \brief ANNOTATION: Refractive index variation.

  dcomplex *dlri;

  //! \brief Vector of dielectric constants.

  dcomplex *dc0;
@@ -268,9 +268,9 @@ public: 
  double ecs;

  //! \brief Sphere absorption cross-section.

  double acs;

  //! \brief TBD.

  //! \brief ANNOTATION: Geometric tensor.

  dcomplex **gis;

  //! \brief TBD.

  //! \brief ANNOTATION: Geometric tensor.

  dcomplex **gls;

  //! \brief Mean scattering amplitude components.

  dcomplex **sam;
@@ -308,17 +308,17 @@ public: 
  //! \brief Read-only view of NDM.

  const int& ndm = _ndm;



  //! \brief TBD

  //! \brief ANNOTATION: Hankel vector.

  dcomplex *vh;

  //! \brief TBD

  //! \brief ANNOTATION: J0 vector.

  dcomplex *vj0;

  //! \brief TBD

  //! \brief ANNOTATION: Translation vector.

  dcomplex *vyhj;

  //! \brief TBD

  //! \brief ANNOTATION: J0 translation vector.

  dcomplex *vyj0;

  //! \brief TBD

  //! \brief ANNOTATION: J vector.

  dcomplex vj;

  //! \brief Transition matrix

  //! \brief Transition matrix.

  dcomplex **am0m;

  //! \brief Cluster forward scattering amplitude.

  dcomplex **fsac;
@@ -336,7 +336,7 @@ public: 
  dcomplex *scscpm;

  //! \brief Mean cluster polarized extinction cross-sections.

  dcomplex *ecscpm;

  //! \brief TBD

  //! \brief ANNOTATION: J0 vector.

  double *v3j0;

  //! \brief Cluster scattering cross-sections.

  double *scsc;
@@ -353,23 +353,23 @@ public: 
  // >>> END OF SECTION NEEDED BY CLUSTER AND INCLU <<< //



  // >>> NEEDED BY INCLU <<< //

  //! \brief TBD

  //! \brief ANNOTATION: M coefficients.

  dcomplex *rm0;

  //! \brief TBD

  //! \brief ANNOTATION: E coefficients.

  dcomplex *re0;

  //! \brief TBD

  //! \brief ANNOTATION: M amplitude coefficients.

  dcomplex *rmw;

  //! \brief TBD

  //! \brief ANNOTATION: E amplitude coefficients.

  dcomplex *rew;

  //! \brief TBD

  //! \brief ANNOTATION: Transition M coefficients.

  dcomplex *tm;

  //! \brief TBD

  //! \brief ANNOTATION: Transition E coefficients.

  dcomplex *te;

  //! \brief TBD

  //! \brief ANNOTATION: Initial transition M coefficients.

  dcomplex *tm0;

  //! \brief TBD

  //! \brief ANNOTATION: Initial transition E coefficients.

  dcomplex *te0;

  //! \brief TBD

  //! \brief ANNOTATION: Included particle T-matrix.

  dcomplex **at;

  // >>> END OF SECTION NEEDED BY INCLU <<< //

src/include/inclu_subs.h

+10 −10
Original line number Diff line number Diff line
@@ -34,7 +34,7 @@ 
 * \param n: `int` Bessel y function order.

 * \param z: `dcomplex` Argument of Bessel y function.

 * \param nm: `int` Maximum computed order.

 * \param csj: `dcomplex *` TBD.

 * \param csj: `dcomplex *` ANNOTATION: Complex spherical J vector.

 * \param csy: `dcomplex *` Complex spherical Bessel functions up to desired order.

 */

void cnf(int n, dcomplex z, int nm, dcomplex *csj, dcomplex *csy);
@@ -49,7 +49,7 @@ void exma(dcomplex **am, ParticleDescriptor *c1); 
/*! \brief C++ porting of INCMS.

 *

 * \param am: `dcomplex **` Field transition coefficients matrix.

 * \param enti: `double` TBD.

 * \param enti: `double` ANNOTATION: imaginary part of coating dielectric function.

 * \param c1: `ParticleDescriptor *` Pointer to a ParticleDescriptor instance.

 */

void incms(dcomplex **am, double enti, ParticleDescriptor *c1);
@@ -57,15 +57,15 @@ void incms(dcomplex **am, double enti, ParticleDescriptor *c1); 
/*! \brief C++ porting of INDME.

 *

 * \param i: `int` 1-based sphere configuration index.

 * \param npnt: `int` TBD.

 * \param npntts: `int` TBD.

 * \param npnt: `int` ANNOTATION: Number of non transition layer integration points.

 * \param npntts: `int` ANNOTATION: Number of transition layer integrtion points.

 * \param vk: `double` Vacuum wave vector magnitude.

 * \param ent: `dcomplex` TBD.

 * \param enti: `double` TBD.

 * \param entn: `dcomplex` TBD.

 * \param ent: `dcomplex` ANNOTATION: coating dielectric function.

 * \param enti: `double` ANNOTATION: imaginary part of coating dielectric function.

 * \param entn: `dcomplex` ANNOTATION: coating refractive index.

 * \param jer: `int &` Error code flag.

 * \param lcalc: `int &` Maximum order achieved in calculation.

 * \param arg: `dcomplex &` TBD.

 * \param arg: `dcomplex &` ANNOTATION: argument of calculation.

 * \param c1: `ParticleDescriptor *` Pointer to a ParticleDescriptor instance.

 */

void indme(
@@ -83,8 +83,8 @@ void instr(double **rcf, ParticleDescriptor *c1); 
/*! \brief C++ porting of OSPV.

 *

 * \param c1: `ParticleDescriptor *` Pointer to a ParticleDescriptor instance.

 * \param vk: `double` TBD.

 * \param sze: `double` TBD.

 * \param vk: `double` ANNOTATION: vacuum wave number.

 * \param sze: `double` ANNOTATION: size.

 * \param exri: `double` External medium refractive index.

 * \param entn: `dcomplex` Outer sphere refractive index.

 * \param enti: `double` Imaginary part of the outer medium refractive index.