diff --git a/Doxyfile b/Doxyfile index 8685a2c..1fa7b9c 100644 --- a/Doxyfile +++ b/Doxyfile @@ -574,7 +574,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = FDTD tools +INPUT = . FDTD tools # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/FDTD/engine_multithread.h b/FDTD/engine_multithread.h index ff062c8..6b5ffe3 100644 --- a/FDTD/engine_multithread.h +++ b/FDTD/engine_multithread.h @@ -86,7 +86,7 @@ public: virtual void Init(); virtual void Reset(); - //!Iterate a number of timesteps + //! Iterate \a iterTS number of timesteps virtual bool IterateTS(unsigned int iterTS); protected: diff --git a/FDTD/excitation.h b/FDTD/excitation.h index bc31df2..984d128 100644 --- a/FDTD/excitation.h +++ b/FDTD/excitation.h @@ -68,9 +68,9 @@ protected: //! Calculate a custom signal virtual void CalcCustomExcitation(double f0, int nTS, string signal); - //! Calculate an excitation with center of f0 and the half bandwidth fc + //! Calculate an excitation with center of \a f0 and the half bandwidth \a fc virtual void CalcGaussianPulsExcitation(double f0, double fc, int nTS); - //! Calculate a sinusoidal excitation with frequency f0 and a duration of nTS number of timesteps + //! Calculate a sinusoidal excitation with frequency \a f0 and a duration of \a nTS number of timesteps virtual void CalcSinusExcitation(double f0, int nTS); //! Calculate a dirac impuls excitation virtual void CalcDiracPulsExcitation(); diff --git a/FDTD/operator.h b/FDTD/operator.h index 0b8dbea..eb056e7 100644 --- a/FDTD/operator.h +++ b/FDTD/operator.h @@ -56,9 +56,9 @@ public: double GetTimestep() const {return dT;}; double GetNumberCells() const; - //! Returns the number of lines as needed for post-processing etc. (for the engine, use GetOriginalNumLines) + //! Returns the number of lines as needed for post-processing etc. (for the engine, use GetOriginalNumLines()) virtual unsigned int GetNumberOfLines(int ny) const {return numLines[ny];} - //! Returns the number of lines as needed for the engine etc. (for post-processing etc, use GetOriginalNumLines) + //! Returns the number of lines as needed for the engine etc. (for post-processing etc, use GetOriginalNumLines()) virtual unsigned int GetOriginalNumLines(int ny) const {return numLines[ny];} virtual void ShowStat() const; @@ -77,9 +77,9 @@ public: //! Get the mesh delta times the grid delta for a 3D position (unit is meter) virtual double GetMeshDelta(int n, const unsigned int* pos, bool dualMesh=false) const; - //! Get the disc line in n direction (in drawing units) + //! Get the disc line in \a n direction (in drawing units) virtual double GetDiscLine(int n, int pos, bool dualMesh=false) const; - //! Get the disc line in n direction (in drawing units) + //! Get the disc line in \a n direction (in drawing units) virtual double GetDiscLine(int n, unsigned int pos, bool dualMesh=false) const; virtual bool SnapToMesh(double* coord, unsigned int* uicoord, bool lower=false, bool* inside=NULL); @@ -124,7 +124,7 @@ protected: double CalcTimestep_Var1(); double CalcTimestep_Var3(); - //! Calc operator at certain pos + //! Calc operator at certain \a pos virtual void Calc_ECOperatorPos(int n, unsigned int* pos); //EC elements, internal only! diff --git a/FDTD/operator_ext_mur_abc.h b/FDTD/operator_ext_mur_abc.h index b8136e9..df8291b 100644 --- a/FDTD/operator_ext_mur_abc.h +++ b/FDTD/operator_ext_mur_abc.h @@ -28,7 +28,7 @@ public: Operator_Ext_Mur_ABC(Operator* op); ~Operator_Ext_Mur_ABC(); - //! Define the direction of this ABC: ny=0,1,2 -> x,y,z and if at bottom_ny -> e.g. x=0 or x=end + //! Define the direction of this ABC: \a ny=0,1,2 -> x,y,z and if at bottom_ny -> e.g. x=0 or x=end void SetDirection(int ny, bool top_ny); virtual bool BuildExtension(); diff --git a/FDTD/operator_sse.cpp b/FDTD/operator_sse.cpp index 9a705d1..4015e09 100644 --- a/FDTD/operator_sse.cpp +++ b/FDTD/operator_sse.cpp @@ -43,7 +43,7 @@ Operator_sse::~Operator_sse() Engine* Operator_sse::CreateEngine() const { - //!create a special sse-engine + //! create a special sse-engine Engine_sse* eng = Engine_sse::New(this); return eng; } diff --git a/FDTD/operator_sse_compressed.cpp b/FDTD/operator_sse_compressed.cpp index cb654ca..f89de23 100644 --- a/FDTD/operator_sse_compressed.cpp +++ b/FDTD/operator_sse_compressed.cpp @@ -58,7 +58,7 @@ Engine* Operator_SSE_Compressed::CreateEngine() const { if (m_Use_Compression==false) { - //!create a default sse-engine + //! create a default sse-engine Engine_sse* eng = Engine_sse::New(this); return eng; } diff --git a/FDTD/operator_sse_compressed.h b/FDTD/operator_sse_compressed.h index 354ccb7..30465f5 100644 --- a/FDTD/operator_sse_compressed.h +++ b/FDTD/operator_sse_compressed.h @@ -50,14 +50,14 @@ protected: bool m_Max_Compression; //reached maximal compression? unsigned int m_Op_Count; - //! Compression ratio threshold. If this ratio is exceeded, compression will be disabled. \sa SetCompressionThreshold + //! Compression ratio threshold. If this ratio is exceeded, compression will be disabled. \sa SetCompressionThreshold() double m_Compression_Threshold; //default is 0.8 virtual void Init(); virtual void Reset(); virtual void InitOperator(); - //! Compression cache size, default is 1000 \sa SetCacheSize + //! Compression cache size, default is 1000 \sa SetCacheSize() unsigned int m_max_fifo; bool CompareOperators(unsigned int pos1[3], unsigned int pos2[3]); diff --git a/FDTD/processfields.h b/FDTD/processfields.h index 14ddef9..3ff197a 100644 --- a/FDTD/processfields.h +++ b/FDTD/processfields.h @@ -36,13 +36,13 @@ public: virtual void DefineStartStopCoord(double* dstart, double* dstop); - //! Define a field dump sub sampling rate for a given direction (default: dir = -1 means all directions) + //! Define a field dump sub sampling rate for a given direction (default: \a dir = -1 means all directions) virtual void SetSubSampling(unsigned int subSampleRate, int dir=-1); - //! Used file pattern e.g. pattern="tmp/efield_" --> "tmp/efield_000045.vtk" for timestep 45 or "tmp/efield_2.40000e9.vtk" for 2.4GHz E-field dump. (VTK FileType only) \sa SetFileType + //! Used file pattern e.g. pattern="tmp/efield_" --> "tmp/efield_000045.vtk" for timestep 45 or "tmp/efield_2.40000e9.vtk" for 2.4GHz E-field dump. (VTK FileType only) \sa SetFileType() void SetFilePattern(string fp) {m_filename=filePattern=fp;} - //! Set the filename for a hdf5 data group file (HDF5 FileType only) \sa SetFileType + //! Set the filename for a hdf5 data group file (HDF5 FileType only) \sa SetFileType() void SetFileName(string fn) {m_filename=fn;} //! Define the Dump-Mode @@ -61,9 +61,9 @@ public: static void WriteVTKCartesianGridHeader(ofstream &file, double const* const* discLines, unsigned int const* numLines, unsigned int precision=12, string header_info = string(), double discLines_scaling = 1); //! Write a vtk header to an already open file (cylindrical grid) static void WriteVTKCylindricalGridHeader(ofstream &file, double const* const* discLines, unsigned int const* numLines, unsigned int precision=12, string header_info = string(), double discLines_scaling = 1); - //! Append a vtk vector array to an already open vtk file, write a header first! \sa WriteVTKHeader + //! Append a vtk vector array to an already open vtk file, write a header first! \sa WriteVTKHeader() static void WriteVTKVectorArray(ofstream &file, string name, FDTD_FLOAT const* const* const* const* array, unsigned int const* numLines, unsigned int precision=12); - //! Append a vtk scalar array to an already open vtk file, write a header first! \sa WriteVTKHeader + //! Append a vtk scalar array to an already open vtk file, write a header first! \sa WriteVTKHeader() static void WriteVTKScalarArray(ofstream &file, string name, FDTD_FLOAT const* const* const* array, unsigned int const* numLines, unsigned int precision=12); static bool DumpVectorArray2VTK(ofstream &file, string name, FDTD_FLOAT const* const* const * const* array, double const* const* discLines, unsigned int const* numLines, unsigned int precision=12, string header_info = string(), MeshType meshT = CARTESIAN_MESH, double discLines_scaling = 1); diff --git a/FDTD/processing.h b/FDTD/processing.h index 2e00e84..cd3a48d 100644 --- a/FDTD/processing.h +++ b/FDTD/processing.h @@ -49,9 +49,9 @@ public: bool CheckTimestep(); virtual int Process() {return GetNextInterval();} - //! If Disabled Process() will do nothing... + //! If disabled, Process() will do nothing... virtual void SetEnable(bool val) {Enabled=val;} - //! If Disabled Process() will do nothing... + //! If disabled, Process() will do nothing... virtual bool GetEnable() const {return Enabled;} virtual void SetWeight(double weight) {m_weight=weight;} diff --git a/openems.cpp b/openems.cpp index 549d381..1195116 100644 --- a/openems.cpp +++ b/openems.cpp @@ -73,8 +73,8 @@ void openEMS::Reset() } //! \brief processes a command line argument -//! returns true if argument is known -//! returns false if argument is unknown +//! \return true if argument is known +//! \return false if argument is unknown bool openEMS::parseCommandLineArgument( const char *argv ) { if (!argv)