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

Use doxygen compliant syntax for class documentation

parent 4c9b8fe1
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -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
+20 −19
Original line number Diff line number Diff line
/*! \class DEDFB
/**
 * \brief A class to represent EDFB configuration data.
 *
 * This class replicates the structure of formatted DEDFB input data
@@ -32,10 +32,6 @@ class DEDFB {
  double *dc0;

public:
  DEDFB(std::string file_name);
  void print();
};

  /*! \fn DEDFB(std::string)
   * \brief Data structure constructor.
   *
@@ -48,6 +44,17 @@ public:
   *
   * 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();
};

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);