Changeset caece4 for src/documentation/userinterfaces/textmenu.dox

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().

File:

• src/documentation/userinterfaces/textmenu.dox (modified) (2 diffs)

src/documentation/userinterfaces/textmenu.dox

@@ -3 +3 @@
  * Description: creates and alters molecular systems
  * Copyright (C)  2010 University of Bonn. All rights reserved.
+ * Copyright (C)  2014 Frederik Heber. All rights reserved.
  * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
  */
@@ -16 +17 @@
  * \page userinterfaces-textmenu Text Menu Interface
  *
- *  The textmenu mimicks the graphical interface in having the very same menu
- *  with actions at the same positions. Only visual output can only be obtained
- *  by saving the world at intervals and inspecting the outcome. This is a sort
- *  of lowman's way to a graphical interface but can be done via a remote
- *  machine if its filesystem is mountable.
+ * The textmenu mimicks the graphical interface in having the very same menu
+ * with actions at the same positions. Only visual output can only be obtained
+ * by saving the world at intervals and inspecting the outcome via another program.
+ * This is a sort of layman's way to a graphical interface but can be done via a 
+ * remote machine if its filesystem is mountable.
  *
- *  \note The textmenu interface is the least maintained part of the user
- *  interfaces, so be cautious in using it. However, it also has the smallest
- *  impact in terms of code lines. In effect it may work just as well as the
- *  others.
+ * \note The textmenu interface is the least maintained part of the user
+ * interfaces, so be cautious in using it. However, it also has the smallest
+ * impact in terms of code lines. In effect it may work just as well as the
+ * others.
  *
  *
- *  \date 2011-10-31
+ * \date 2014-03-10
  *
  */