From c0df7886284f521ac1ef9a706a50b845c9b32454 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Ne=C4=8Dada?= Date: Tue, 19 Feb 2019 21:41:10 +0000 Subject: [PATCH] Doxygen fixes. Former-commit-id: 13bb4c452a3bf44c97b6dee53a61921f3029f3f1 --- qpms/qpms_types.h | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/qpms/qpms_types.h b/qpms/qpms_types.h index f382849..34e34f7 100644 --- a/qpms/qpms_types.h +++ b/qpms/qpms_types.h @@ -49,9 +49,9 @@ typedef size_t qpms_y_sc_t; /// Codes of the VSWF types (electric/N, magnetic/M, longitudinal/L). typedef enum { - QPMS_VSWF_ELECTRIC = 2, /// "Electric" ($N$-type) transversal wave. - QPMS_VSWF_MAGNETIC = 1, /// "Magnetic" ($M$-type) transversal wave. - QPMS_VSWF_LONGITUDINAL = 0 /// Longitudinal ($L$-type) wave (not relevant for radiation). + QPMS_VSWF_ELECTRIC = 2, ///< "Electric" ($N$-type) transversal wave. + QPMS_VSWF_MAGNETIC = 1, ///< "Magnetic" ($M$-type) transversal wave. + QPMS_VSWF_LONGITUDINAL = 0 ///< Longitudinal ($L$-type) wave (not relevant for radiation). } qpms_vswf_type_t; @@ -93,12 +93,11 @@ typedef enum { typedef enum { #ifdef USE_XU_ANTINORMALISATION // As in TODO - QPMS_NORMALISATION_XU = 4, /// such that the numerical values in Xu's tables match, not recommended to use otherwise + QPMS_NORMALISATION_XU = 4, ///< such that the numerical values in Xu's tables match, not recommended to use otherwise QPMS_NORMALISATION_XU_CS = QPMS_NORMALISATION_XU | QPMS_NORMALISATION_T_CSBIT, #endif - QPMS_NORMALISATION_NONE = 3, /// genuine unnormalised waves (with unnormalised Legendre polynomials) - /// As in http://www.eit.lth.se/fileadmin/eit/courses/eit080f/Literature/book.pdf, power-normalised - QPMS_NORMALISATION_KRISTENSSON = 2, + QPMS_NORMALISATION_NONE = 3, ///< genuine unnormalised waves (with unnormalised Legendre polynomials) + QPMS_NORMALISATION_KRISTENSSON = 2, ///< As in http://www.eit.lth.se/fileadmin/eit/courses/eit080f/Literature/book.pdf, power-normalised QPMS_NORMALISATION_POWER = QPMS_NORMALISATION_KRISTENSSON, // as in TODO QPMS_NORMALISATION_TAYLOR = 1,