Author: Kristian Kaufmann
location: doc/template_doxygen_pages/TemplateAppDocPage.dox
last updated: 1-21-2009
Documentation for the ligand_dock application is an example of a page like this should look.
The objective of this application is to perform these modeling tasks.
Describe the application and what steps are taken during execution of the application, including preprocessing and post processing of files. A flowchart is particularly recommended for this section.
List and comment on any required additional tools or input files
List and comment on any optional tools or input files
Tell readers where they can find files which can be used to complete the operations you describe in this page.
Describe any preprocessing of files that is required or recommended. Operations such as cleaning of pdb files should be mentioned here.
Describe any useful flags or combination of flags for this application. Descibe what readers should expect as output from the application. Include examples of commonly used combination of flags. Write this section as throughly as you can. The better you write this section the less questions you'll receive and the more popular your application will be.
Describe the post processing of files. Include as much guidance as possible regarding the evaluation/quantification of results. Give guidance as to limits of your applications. How accurate/precise do you expect the results to be.
Include commonly encountered questions.