Changeset 750cff for src/documentation/tests/tests.dox

Timestamp:

Oct 31, 2011, 5:13:52 PM (14 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, Candidate_v1.7.0, 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:

5982c5

Parents:

19bc74

Message:

HUGE: Update on documenation.

• a general skeleton of the documentation is now in place with all the major components of MoleCuilder explained to some extent.
• some information has been transfered from TRAC (e.g. install procecure) into this doxygen documentation where it is general and not specific to the situation at our institute.

File:

• src/documentation/tests/tests.dox (modified) (3 diffs)

src/documentation/tests/tests.dox

@@ -25 +25 @@
  * testing. Tests are regarded here as a kind of contract. The code itself is
  * just one hand in two hands shaking, the other hand is resembled by the tests
- * that checks whether the code does exactly what it's supposed to do. Without
- * testing a larger project is impossible because it cannot evolve. With
- * increasing size, a project must be refactored
- * (http://en.wikipedia.org/wiki/Code_refactoring) such that new code does not
- * have to wiggle itself around the same old issues that are present from the
- * start. Before one starts refactoring, it must be assured by some means that
- * the code before and after behaves the same with respect to its intended
- * functionality. These means are the tests.
+ * that check whether the code does exactly what it's supposed to do. Without
+ * testing a larger project is impossible because it cannot evolve: The old
+ * addage and compromises grow and grow. With increasing size, a project must be
+ * refactored (http://en.wikipedia.org/wiki/Code_refactoring) such that new code
+ * does not have to wiggle itself around the same old issues that are
+ * inadvertently and unavoidably present from the start. Before one starts
+ * refactoring, it must be assured by some means that the code before and after
+ * behaves the same with respect to its intended functionality. These means are
+ * the tests.
  *
- * Unit tests (http://en.wikipedia.org/wiki/Unit_testing) tests single
- * components (e.g. classes), dependencies on other classes are often just
- * mimicked via so-called stubs. These test whether a component always behaves
- * as desired.
+ * Unit tests (http://en.wikipedia.org/wiki/Unit_testing) check on single
+ * components (e.g. classes), dependencies of the components on other classes
+ * with the test frame are often just mimicked via so-called stubs (sort of
+ * dummy components that don't calculate or do anything but return an expected
+ * result suitable for this test only, see http://en.wikipedia.org/wiki/Test_stubs).
+ * These test whether a component always behaves as desired.
  *
  * Regression test (http://en.wikipedia.org/wiki/Regression_testing) on the other
@@ -45 +48 @@
  * has not changed the outcome of older functions.
  *
+ * \section tests-launch-all Launching all tests
+ *
  * Note that all tests can be launched via
  * \code make check \endcode
  * in the top build directory.
  *
- * \section Policy on launching tests
+ * \section tests-policy Policy on launching tests
  *
  * Note that the above run of \e all \e tests \e should \e pass for each and
@@ -60 +65 @@
  * runs fine and produces a distributable archive.
  *
+ * \date 2011-10-31
+ *
  */