Changeset caece4 for src/documentation/tests

Timestamp:

May 20, 2014, 9:14:56 AM (11 years ago)

Author:

Frederik Heber <heber@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

6029a6

Parents:

74459a

git-author:

Frederik Heber <heber@…> (03/20/14 17:23:35)

git-committer:

Frederik Heber <heber@…> (05/20/14 09:14:56)

Message:

Enhanced documentation significantly.

• went through all of the constructs and updated each.
• enhanced documentation ofr Fragmentation::FragmentMolecule().

Location:

src/documentation/tests

Files:

• code-tests.dox (modified) (2 diffs)
• regression-tests.dox (modified) (1 diff)

src/documentation/tests/code-tests.dox

@@ -23 +23 @@
  * -# Every .hpp files must include \b config.h
  * -# Every .dox file contains a (correctly formatted: YYYY-MM-DD) date stamp.
+ * -# Every .cpp file must contain a correct copyright header
+ * -# Every .hpp file must be present in a Makefile.am (for distributable archive)
  *
  * These make sure that the memory debugger is catching every movement on the
@@ -95 +97 @@
  *  -# Add the file as an \e m4_include directive to testsuite.at.
  *
+ *  These files may also contain exceptions which are stored as a simple list of
+ *  files for which one of the above rules does not apply.
  *
- * \date 2011-10-31
+ * \date 2014-03-10
  *
  */

src/documentation/tests/regression-tests.dox

@@ -20 +20 @@
  *
  * Regression test with this project are used to check on the functionality of
- * all Actions. The launch the MoleCuilder from the command line with a given
+ * all Actions. They launch MoleCuilder from the command line with a given
  * action and option and basically diff the output against a stored file with
  * the desired result. This should be the behavior of more than 90% of all
- * regression tests.
+ * regression tests. 
+ * For some we additionally catch the output from stdout and stderr and diff against
+ * it, but this is actually not a recommended way of testing as output depends very
+ * much on the logging level.
  *
  * \section regressiontest-structure Directory structure