Fix doxygen warnings on function signatures (75e61c67) · Commits · Giacomo Mulas / NP_TMcode

src/include/file_io.h

+1 −0

Original line number	Diff line number	Diff line
		@@ -29,6 +29,7 @@ class FileSchema {
		*
		* \param num_rec: `int` Number of records in the file.
		* \param rec_types: `string *` Description of the records in the file.
		* \param rec_names: `string *` Names of the records in the file.
		*/
		FileSchema(int num_rec, std::string rec_types, std::string rec_names=NULL);

src/include/sph_subs.h

+2 −2

Original line number	Diff line number	Diff line
		@@ -35,7 +35,7 @@ void aps(double ***zpv, int li, int nsph, C1 c1, double sqk, double *gaps);
		* backward recurrence. This is the `CSPHJ` implementation of the `specfun` library.
		*
		* \param n: `int` Order of the function.
		* \param z: `complex<double>` Argumento of the function.
		* \param z: `complex<double>` Argument of the function.
		* \param nm: `int &` Highest computed order.
		* \param csj: Vector of complex. The desired function \f$j\f$.
		*/
		@@ -140,7 +140,7 @@ int msta1(double x, int mp);
		* This function determines the starting point for backward recurrence such that
		* all \f$J\f$ and \f$j\f$ functions have `mp` significant digits.
		*
		* \param x: `double` Absolute value of the argumetn to \f$J\f$ or \$j\f$.
		* \param x: `double` Absolute value of the argumetn to \f$J\f$ or \f$j\f$.
		* \param n: `int` Order of the function.
		* \param mp: `int` Requested number of significant digits.
		* \return result: `int` The necessary starting point.

src/include/tra_subs.h

+0 −1

Original line number	Diff line number	Diff line
		@@ -97,7 +97,6 @@ void ffrf(
		* \param ffte: `double *`. QUESTION: definition?
		* \param ffts: `double *`. QUESTION: definition?
		* \param cil: `CIL *` Pointer to a CIL structure.
		* \param ccr: `CCR *` Pointer to a CCR structure.
		*/
		void ffrt(
		std::complex<double> ac, std::complex<double> ws, double ffte, double ffts,

src/libnptm/TransitionMatrix.cpp

+2 −2

Original line number	Diff line number	Diff line
		@@ -48,8 +48,8 @@ TransitionMatrix::TransitionMatrix(
		}

		TransitionMatrix::TransitionMatrix(
		int _lm, double _vk, double _exri, complex<double> **_rmi,
		complex<double> **_rei, double _sphere_radius
		int _lm, double _vk, double _exri, std::complex<double> **_rmi,
		std::complex<double> **_rei, double _sphere_radius
		) {
		is = 1111;
		shape = new int[2];

src/libnptm/clu_subs.cpp

+12 −12

Original line number	Diff line number	Diff line
		@@ -19,8 +19,8 @@
		using namespace std;

		void apc(
		double **zpv, int le, complex<double> am0m, complex<double> **w,
		double sqk, double gapr, complex<double> gapp
		double **zpv, int le, std::complex<double> am0m, std::complex<double> **w,
		double sqk, double gapr, std::complex<double> gapp
		) {
		complex<double> ac, gap;
		const complex<double> cc0(0.0, 0.0);
		@@ -137,8 +137,8 @@ void apc(
		}

		void apcra(
		double **zpv, const int le, complex<double> am0m, int inpol, double sqk,
		double gaprm, complex<double> gappm
		double **zpv, const int le, std::complex<double> am0m, int inpol, double sqk,
		double gaprm, std::complex<double> gappm
		) {
		const complex<double> cc0(0.0, 0.0);
		const complex<double> uim(0.0, 1.0);
		@@ -358,7 +358,7 @@ void apcra(
		}

		complex<double> cdtp(
		complex<double> z, complex<double> **am, int i, int jf,
		std::complex<double> z, std::complex<double> **am, int i, int jf,
		int k, int nj
		) {
		/* NOTE: the original FORTRAN code treats the AM matrix as a
		@@ -409,7 +409,7 @@ double cgev(int ipamo, int mu, int l, int m) {
		return result;
		}

		void cms(complex<double> *am, C1 c1, C1_AddOns c1ao, C4 c4, C6 *c6) {
		void cms(std::complex<double> *am, C1 c1, C1_AddOns c1ao, C4 c4, C6 *c6) {
		complex<double> dm, de, cgh, cgk;
		const complex<double> cc0(0.0, 0.0);
		int ndi = c4->nsph * c4->nlim;
		@@ -823,7 +823,7 @@ complex<double> ghit(
		}

		void hjv(
		double exri, double vk, int &jer, int &lcalc, complex<double> &arg,
		double exri, double vk, int &jer, int &lcalc, std::complex<double> &arg,
		C1 c1, C1_AddOns c1ao, C4 *c4
		) {
		int nsphmo = c4->nsph - 1;
		@@ -892,7 +892,7 @@ void hjv(
		delete[] rfn;
		}

		void lucin(complex<double> **am, const int nddmst, int n, int &ier) {
		void lucin(std::complex<double> **am, const int nddmst, int n, int &ier) {
		/* NDDMST FIRST DIMENSION OF AM AS DECLARED IN DIMENSION
		* STATEMENT.
		* N NUMBER OF ROWS IN AM.
		@@ -997,7 +997,7 @@ void lucin(complex<double> **am, const int nddmst, int n, int &ier) {
		delete[] v;
		}

		void mextc(double vk, double exri, complex<double> fsac, double cextlr, double **cext) {
		void mextc(double vk, double exri, std::complex<double> fsac, double cextlr, double **cext) {
		double fa11r = fsac[0][0].real();
		double fa11i = fsac[0][0].imag();
		double fa21r = fsac[1][0].real();
		@@ -1538,8 +1538,8 @@ void r3jmr(int j1, int j2, int j3, int m1, C6 *c6) {
		}

		void raba(
		int le, complex<double> am0m, complex<double> w, double **tqce,
		complex<double> tqcpe, double tqcs, complex<double> **tqcps
		int le, std::complex<double> am0m, std::complex<double> w, double **tqce,
		std::complex<double> tqcpe, double tqcs, std::complex<double> **tqcps
		) {
		complex<double> a, ctqce, **ctqcs;
		complex<double> acw, acwp, aca, acap, c1, c2, c3;
		@@ -1901,7 +1901,7 @@ void tqr(
		tsk = u[0] * tqsv[0] + u[1] * tqsv[1] + u[2] * tqsv[2];
		}

		void ztm(complex<double> *am, C1 c1, C1_AddOns c1ao, C4 c4, C6 c6, C9 c9) {
		void ztm(std::complex<double> *am, C1 c1, C1_AddOns c1ao, C4 c4, C6 c6, C9 c9) {
		complex<double> gie, gle, a1, a2, a3, a4, sum1, sum2, sum3, sum4;
		const complex<double> cc0(0.0, 0.0);
		int ndi = c4->nsph * c4->nlim;