Added documentation on configuration commands

git-svn-id: https://subversion.xor.aps.anl.gov/synApps/areaDetector/trunk@9164 dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b
This commit is contained in:
rivers
2009-08-04 16:27:59 +00:00
parent 62644b6eef
commit 6c12d03c37
+41 -1
View File
@@ -93,9 +93,22 @@
(longin).
</p>
<p>
The <a href="areaDetectorDoxygenHTML/class_n_d_file_j_p_e_g.html">NDFileNetJPEG class
The <a href="areaDetectorDoxygenHTML/class_n_d_file_j_p_e_g.html">NDFileJPEG class
documentation </a>describes this class in detail.
</p>
<p>
The NDFileJPEG plugin is created with the NDFileJPEGConfigure command, either from
C/C++ or from the EPICS IOC shell.</p>
<pre>NDFileJPEGConfigure (const char *portName, int queueSize, int blockingCallbacks,
const char *NDArrayPort, int NDArrayAddr, size_t maxMemory,
int priority, int stackSize)
</pre>
<p>
For details on the meaning of the parameters to this function refer to the detailed
documentation on the NDFileJPEGConfigure function in the <a href="areaDetectorDoxygenHTML/_n_d_file_j_p_e_g_8cpp.html">
NDFileJPEG.cpp documentation</a> and in the documentation for the constructor
for the <a href="areaDetectorDoxygenHTML/class_n_d_file_j_p_e_g.html">NDFileJPEG class</a>.
</p>
<h2 id="TIFF">
TIFF file plugin
</h2>
@@ -115,6 +128,19 @@
The <a href="areaDetectorDoxygenHTML/class_n_d_file_t_i_f_f.html">NDFileNetTIFF class
documentation </a>describes this class in detail.
</p>
<p>
The NDFileTIFF plugin is created with the NDFileTIFFConfigure command, either from
C/C++ or from the EPICS IOC shell.</p>
<pre>NDFileTIFFConfigure (const char *portName, int queueSize, int blockingCallbacks,
const char *NDArrayPort, int NDArrayAddr, size_t maxMemory,
int priority, int stackSize)
</pre>
<p>
For details on the meaning of the parameters to this function refer to the detailed
documentation on the NDFileTIFFConfigure function in the <a href="areaDetectorDoxygenHTML/_n_d_file_t_i_f_f_8cpp.html">
NDFileTIFF.cpp documentation</a> and in the documentation for the constructor
for the <a href="areaDetectorDoxygenHTML/class_n_d_file_t_i_f_f.html">NDFileTIFF class</a>.
</p>
<h2 id="netCDF">
netCDF file plugin
</h2>
@@ -141,6 +167,20 @@
The <a href="areaDetectorDoxygenHTML/class_n_d_file_net_c_d_f.html">NDFileNetCDF class
documentation </a>describes this class in detail.
</p>
<p>
The NDFileNetCDF plugin is created with the NDFileNetCDFConfigure command, either
from C/C++ or from the EPICS IOC shell.</p>
<pre>NDFileNetCDFConfigure (const char *portName, int queueSize, int blockingCallbacks,
const char *NDArrayPort, int NDArrayAddr, size_t maxMemory,
int priority, int stackSize)
</pre>
<p>
For details on the meaning of the parameters to this function refer to the detailed
documentation on the NDFileNetCDFConfigure function in the <a href="areaDetectorDoxygenHTML/_n_d_file_net_c_d_f_8cpp.html">
NDFileNetCDF.cpp documentation</a> and in the documentation for the constructor
for the <a href="areaDetectorDoxygenHTML/class_n_d_file_net_c_d_f.html">NDFileNetCDF
class</a>.
</p>
<p>
The following is the header contents of a netCDF file produced by this plugin. This
information was produced with the following command:</p>