diff options
| author | Thomas White <taw@bitwiz.org.uk> | 2011-03-26 22:42:49 +0100 |
|---|---|---|
| committer | Thomas White <taw@physics.org> | 2012-02-22 15:27:22 +0100 |
| commit | b730350f342972083bc28195d0042b2485135ee9 (patch) | |
| tree | 3dc017ebeb1fe5c66f83240498ec5c2a8d1c0ee8 /doc/reference | |
| parent | 5ccdcc43256c8bb6efee7e13d84ea868a288dd71 (diff) | |
More documentation stuff
Diffstat (limited to 'doc/reference')
| -rw-r--r-- | doc/reference/CrystFEL-docs.sgml | 7 | ||||
| -rw-r--r-- | doc/reference/CrystFEL-sections.txt | 6 |
2 files changed, 12 insertions, 1 deletions
diff --git a/doc/reference/CrystFEL-docs.sgml b/doc/reference/CrystFEL-docs.sgml index 08f97f3d..ba20fbea 100644 --- a/doc/reference/CrystFEL-docs.sgml +++ b/doc/reference/CrystFEL-docs.sgml @@ -10,9 +10,13 @@ <releaseinfo> For CrystFEL 0.2.0. </releaseinfo> + <abstract> This is the internal documentation for CrystFEL. Unless you are looking at the code, writing new programs or fixing bugs, you should not need to read - this. + this. You might use the information here when reading the code or to better + understand how the software works, or refer to it when creating a new + program within the suite. + </abstract> </bookinfo> <chapter> @@ -22,6 +26,7 @@ <chapter> <title>Handling reflection data</title> + <abstract>There are three main reflection list thingies.</abstract> <xi:include href="xml/reflist.xml"/> <xi:include href="xml/reflitemlist.xml"/> </chapter> diff --git a/doc/reference/CrystFEL-sections.txt b/doc/reference/CrystFEL-sections.txt index 1adda7b5..b6021270 100644 --- a/doc/reference/CrystFEL-sections.txt +++ b/doc/reference/CrystFEL-sections.txt @@ -33,6 +33,12 @@ show_matrix_eqn <SECTION> <FILE>quaternion</FILE> quaternion +<SUBSECTION> +quaternion_modulus +normalise_quaternion +random_quaternion +quaternion_valid +quat_rot </SECTION> <SECTION> |