Changeset b2c302 for src/documentation/constructs

Timestamp:

Apr 11, 2012, 4:56:55 PM (13 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:

e44956

Parents:

be21fa

git-author:

Frederik Heber <heber@…> (03/16/12 12:29:01)

git-committer:

Frederik Heber <heber@…> (04/11/12 16:56:55)

Message:

DOCU: Extended documentation on how values from the user are eventually used by Actions.

• updated ValueStorage docu.

Location:

src/documentation/constructs

Files:

• actions.dox (modified) (3 diffs)
• constructs.dox (modified) (1 diff)
• values.dox (added)

src/documentation/constructs/actions.dox

@@ -15 +15 @@
 /** \page actions Actions
  *
- *  Actions are Command patterns (http://en.wikipedia.org/wiki/Command_pattern)
+ *  \link MoleCuilder::Action Actions \endlink are Command patterns
+ *  (http://en.wikipedia.org/wiki/Command_pattern)
  *  to allow for undoing and redoing. Each specific Action derives from this
  *  class to implement a certain functionality. There is a lot of preprocessor
@@ -27 +28 @@
  *  such that an instance can be retrieved by knowing this token.
  *
- *  Each Action obtains its parameter from a central ValueStorage such that
- *  they are independent of where the parameter originated from: a command line
+ *  Each Action obtains its options from a central ValueStorage such that
+ *  they are independent of where the option originated from: a command line
  *  parameter, a value entered in a graphical dialog or given via the keyboard
  *  in a terminal. That's why each begins with a function call to
@@ -62 +63 @@
  * Have a look at \ref UndoRedoHelpers.hpp for some helper functions on this.
  *
+ * \section actions-further Further information
+ *
+ * If you want know:
+ * -# how the code knows about the valid tokens for actions and options and how
+ *    they are constructed, see \ref MoleCuilder::Action .
+ *
  *
  *  \date 2012-04-05

src/documentation/constructs/constructs.dox

@@ -36 +36 @@
  *  \li \ref shapes
  *  \li \ref tesselation
+ *  \li \ref values
  *  \li \ref world
  *