[Swift-commit] r4597 - SwiftApps/Montage/docs

[jonmon at ci.uchicago.edu]

Author: jonmon
Date: 2011-06-09 16:36:04 -0500 (Thu, 09 Jun 2011)
New Revision: 4597

Modified:
   SwiftApps/Montage/docs/API.html
   SwiftApps/Montage/docs/API.txt
Log:
updated documentation


Modified: SwiftApps/Montage/docs/API.html
===================================================================
--- SwiftApps/Montage/docs/API.html	2011-06-09 19:02:18 UTC (rev 4596)
+++ SwiftApps/Montage/docs/API.html	2011-06-09 21:36:04 UTC (rev 4597)
@@ -728,14 +728,24 @@
 to parallelize a workflow that has been represented as a swiftscript. Swift
 implements the site execution model to allow for efficient use of available
 resources for the users application.</p></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">Both the Montage binaries as well as the Swift binaries must be included
+in your PATH environment variable for the wrappers to function properly.</td>
+</tr></table>
 </div>
 </div>
+</div>
 <div class="sect1">
 <h2 id="X1">Swift Montage API</h2>
 <div class="sectionbody">
 <div class="sect2">
 <h3 id="_types">Types</h3>
-<div class="paragraph"><p>These are all the Types that are declared for Swift</p></div>
+<div class="paragraph"><p>These are all the Types that are declared for Swift. They are located in the
+file Swift_Montage_types.swift.</p></div>
 <div class="listingblock">
 <div class="title">Image</div>
 <div class="content">
@@ -804,9 +814,17 @@
 </div>
 <div class="sect2">
 <h3 id="_app_procedures">App Procedures</h3>
-<div class="paragraph"><p>These are all the app procedures for Swift Montage. Currently the options to
-the Montage functions are hard coded and the user cannot choose which options
-to run.</p></div>
+<div class="paragraph"><p>These are all the app procedures for Swift Montage. They are located in the
+file Swift_Montage_Apps.swift</p></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">Currently the options to the Montage functions are hard coded and the
+user cannot choose which options to run.</td>
+</tr></table>
+</div>
 <div class="listingblock">
 <div class="title">mAdd</div>
 <div class="content">
@@ -980,7 +998,8 @@
 <div class="sect2">
 <h3 id="_batch_wrappers">Batch Wrappers</h3>
 <div class="paragraph"><p>These are the Batch scripts. These scripts do most of the file mapping
-and is where the parallelization is taking place.</p></div>
+and is where the parallelization is taking place. They are located in the file
+Swift_Montage_Batch.swift</p></div>
 <div class="listingblock">
 <div class="title">mBackgroundBatch</div>
 <div class="content">
@@ -1101,7 +1120,7 @@
 <div id="footnotes"><hr /></div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2011-06-09 10:53:27 CDT
+Last updated 2011-06-09 16:29:55 CDT
 </div>
 </div>
 </body>

Modified: SwiftApps/Montage/docs/API.txt
===================================================================
--- SwiftApps/Montage/docs/API.txt	2011-06-09 19:02:18 UTC (rev 4596)
+++ SwiftApps/Montage/docs/API.txt	2011-06-09 21:36:04 UTC (rev 4597)
@@ -10,6 +10,9 @@
 implements the site execution model to allow for efficient use of available
 resources for the users application.
 
+NOTE: Both the Montage binaries as well as the Swift binaries must be included
+in your PATH environment variable for the wrappers to function properly.
+
 [[X1]]
 
 Swift Montage API
@@ -17,7 +20,8 @@
 
 Types
 ~~~~~
-These are all the Types that are declared for Swift
+These are all the Types that are declared for Swift. They are located in the
+file Swift_Montage_types.swift.
 
 .Image
 ----
@@ -86,10 +90,12 @@
 
 App Procedures
 ~~~~~~~~~~~~~~
-These are all the app procedures for Swift Montage. Currently the options to
-the Montage functions are hard coded and the user cannot choose which options
-to run.
+These are all the app procedures for Swift Montage. They are located in the
+file Swift_Montage_Apps.swift
 
+NOTE: Currently the options to the Montage functions are hard coded and the
+user cannot choose which options to run.
+
 .mAdd
 ----
 app ( Image mos ) mAdd( Image imgs[], Table img_tbl, MosaicData hdr )
@@ -250,7 +256,8 @@
 Batch Wrappers
 ~~~~~~~~~~~~~~
 These are the Batch scripts. These scripts do most of the file mapping
-and is where the parallelization is taking place.
+and is where the parallelization is taking place. They are located in the file
+Swift_Montage_Batch.swift
 
 .mBackgroundBatch
 ----