diff --git a/src/sphere/List.h b/src/sphere/List.h index bed78f2ed17fb63824969910b7809658ff43c4d3..ab4566b2200ee846641b613dd9db72b6e5485f51 100644 --- a/src/sphere/List.h +++ b/src/sphere/List.h @@ -2,7 +2,7 @@ #define LIST_OUT_OF_BOUNDS_EXCEPTION 1 #endif -/*! \class List<T> +/** * \brief A class to represent dynamic lists. * * This class helps in the creation and management of dynamic lists of diff --git a/src/sphere/edfb.h b/src/sphere/edfb.h index f47e4fc49223263363b33eceb42777007fc8eb04..6f28cb504bfffe4d087108d005b309392df2adf9 100644 --- a/src/sphere/edfb.h +++ b/src/sphere/edfb.h @@ -1,4 +1,4 @@ -/*! \class DEDFB +/** * \brief A class to represent EDFB configuration data. * * This class replicates the structure of formatted DEDFB input data @@ -32,22 +32,29 @@ class DEDFB { double *dc0; public: + /*! \fn DEDFB(std::string) + * \brief Data structure constructor. + * + * The default procedure to import a configuration file is to build a + * configuration object, according to one of the following flavours: + * + * DEDFB edfb_cfg = DEDFB("FILE_NAME"); // configuration object + * + * or + * + * DEDFB *edfb_cfg_ptr = new DEDFB("FILE_NAME"); // pointer version + */ DEDFB(std::string file_name); + + /*! \fn print() + * \brief Print the data structure to console. + * + * This is a simple function to print the data read from a configuration + * file to the screen. This operation can be useful for debug and testing. + */ void print(); }; -/*! \fn DEDFB(std::string) - * \brief Data structure constructor. - * - * The default procedure to import a configuration file is to build a - * configuration object, according to one of the following flavours: - * - * DEDFB edfb_cfg = DEDFB("FILE_NAME"); // configuration object - * - * or - * - * DEDFB *edfb_cfg_ptr = new DEDFB("FILE_NAME"); // pointer version - */ DEDFB::DEDFB(std::string file_name) { FILE *input_file = fopen(file_name.c_str(), "r"); int exp_exdc, exp_wp, exp_xip; @@ -116,12 +123,6 @@ DEDFB::DEDFB(std::string file_name) { fclose(input_file); } -/*! \fn print() - * \brief Print the data structure to console. - * - * This is a simple function to print the data read from a configuration - * file to the screen. This operation can be useful for debug and testing. - */ void DEDFB::print() { printf("### CONFIGURATION DATA ###\n"); printf("NSPH = %d\n", nsph);