MikeHeiber / Excimontec / 227

94%

push

travis-ci

Documentation Update (#77)

General:
-Updated Changelog by adding notes about all changes
-Added numerous lines to the .gitignore file to ignore file generated during the build process and Microsoft Visual studio files
-Updated copyright statement in all files to list years 2017-2019
-Updated README by removing badge images for the current release versions
-Updated README by adding build instructions link for Windows users
-Updated Doxyfile to not include markdown files in the documentation
-Added KMC_Lattice documentation to the docs
-Added API documentation for Polaron, Parameters, and OSC_Sim classes
-Revised API documentation for the Exciton class
-Updated documentation using Doxygen v1.8.15
-Added header guards to Exciton, Polaron, OSC_Sim, and Parameters class header files
-Updated parameters_default.txt default morphology file format to remove the compression indicator suffix
-Updated Exciton class constructor to require user to specify the spin state of the new exciton
-Updated main.cpp output of ToF results by renaming the transient current to current density to be more accurate about the type of data produced
-Updated OSC_Sim class getSiteEnergy and getSiteType functions to check for the validity of the input coordinates and generate an error instead of throwing an exception
-Updated OSC_Sim class calculateDOSCorrelation functions by changing scope from public to private
-Updated test.cpp by correcting several spelling mistakes in the test comments

Exciton class:
-Updated derived event classes by nesting them into the object classes

Polaron class:
-Updated derived event classes by nesting them into the object classes

OSC_Sim class:
-Updated functions to use new object event class nesting format
-Updated several function definitions to include namespace details so that function declarations and definitions match each other and can be linked by Doxygen
-Updated generateExciton function declaration to also define ... (continued)

177 of 177 new or added lines in 7 files covered. (100.0%)

2369 of 2514 relevant lines covered (94.23%)

40663158.67 hits per line