summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Vogelgesang <matthias.vogelgesang@gmail.com>2012-10-08 10:04:18 +0200
committerMatthias Vogelgesang <matthias.vogelgesang@gmail.com>2012-10-08 10:05:30 +0200
commit4e78a33ab00c8437d341a4cb83919e2a67e54493 (patch)
tree0905d08b69b2a8e5e90171ecfc5942142de6d4ee
parent5ed330a163073f4aab98995520eebbc15dff83f3 (diff)
downloaduca-4e78a33ab00c8437d341a4cb83919e2a67e54493.tar.gz
uca-4e78a33ab00c8437d341a4cb83919e2a67e54493.tar.bz2
uca-4e78a33ab00c8437d341a4cb83919e2a67e54493.tar.xz
uca-4e78a33ab00c8437d341a4cb83919e2a67e54493.zip
Generate documentation for the base camera object
Diffstat
-rw-r--r--docs/base.html67
-rw-r--r--docs/manual.md2
-rw-r--r--tools/gen-doc.c18
3 files changed, 80 insertions, 7 deletions
diff --git a/docs/base.html b/docs/base.html
new file mode 100644
index 0000000..e86807f
--- /dev/null
+++ b/docs/base.html
@@ -0,0 +1,67 @@
+<html><head><link rel="stylesheet" href="style.css" type="text/css" /><link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700|Droid+Serif:400,400italic|Inconsolata' rel='stylesheet' type='text/css'><title>Basic camera &mdash; properties</title></head><body><div id="header"><h1 class="title">Property documentation of Basic camera</h1><h2>Properties</h2><ul id="toc"><li><code><a href=#name>"name"</a></code></li><li><code><a href=#sensor-width>"sensor-width"</a></code></li><li><code><a href=#sensor-height>"sensor-height"</a></code></li><li><code><a href=#sensor-bitdepth>"sensor-bitdepth"</a></code></li><li><code><a href=#sensor-horizontal-binning>"sensor-horizontal-binning"</a></code></li><li><code><a href=#sensor-horizontal-binnings>"sensor-horizontal-binnings"</a></code></li><li><code><a href=#sensor-vertical-binning>"sensor-vertical-binning"</a></code></li><li><code><a href=#sensor-vertical-binnings>"sensor-vertical-binnings"</a></code></li><li><code><a href=#sensor-max-frame-rate>"sensor-max-frame-rate"</a></code></li><li><code><a href=#trigger-mode>"trigger-mode"</a></code></li><li><code><a href=#exposure-time>"exposure-time"</a></code></li><li><code><a href=#roi-x0>"roi-x0"</a></code></li><li><code><a href=#roi-y0>"roi-y0"</a></code></li><li><code><a href=#roi-width>"roi-width"</a></code></li><li><code><a href=#roi-height>"roi-height"</a></code></li><li><code><a href=#roi-width-multiplier>"roi-width-multiplier"</a></code></li><li><code><a href=#roi-height-multiplier>"roi-height-multiplier"</a></code></li><li><code><a href=#has-streaming>"has-streaming"</a></code></li><li><code><a href=#has-camram-recording>"has-camram-recording"</a></code></li><li><code><a href=#transfer-asynchronously>"transfer-asynchronously"</a></code></li><li><code><a href=#is-recording>"is-recording"</a></code></li><li><code><a href=#is-readout>"is-readout"</a></code></li></ul><h2>Details</h2><dl><dt id="name"><a href="#toc">name</a></dt>
+<dd><pre><code class="prop-type">"name" : gchararray : Read-only</code></pre>
+<p>Name of the camera</p>
+</dd><dt id="sensor-width"><a href="#toc">sensor-width</a></dt>
+<dd><pre><code class="prop-type">"sensor-width" : guint : Read-only</code></pre>
+<p>Width of the sensor in pixels</p>
+</dd><dt id="sensor-height"><a href="#toc">sensor-height</a></dt>
+<dd><pre><code class="prop-type">"sensor-height" : guint : Read-only</code></pre>
+<p>Height of the sensor in pixels</p>
+</dd><dt id="sensor-bitdepth"><a href="#toc">sensor-bitdepth</a></dt>
+<dd><pre><code class="prop-type">"sensor-bitdepth" : guint : Read-only</code></pre>
+<p>Number of bits per pixel</p>
+</dd><dt id="sensor-horizontal-binning"><a href="#toc">sensor-horizontal-binning</a></dt>
+<dd><pre><code class="prop-type">"sensor-horizontal-binning" : guint : Read / Write</code></pre>
+<p>Number of sensor ADCs that are combined to one pixel in horizontal direction</p>
+</dd><dt id="sensor-horizontal-binnings"><a href="#toc">sensor-horizontal-binnings</a></dt>
+<dd><pre><code class="prop-type">"sensor-horizontal-binnings" : GValueArray : Read-only</code></pre>
+<p>Array of possible binnings in horizontal direction</p>
+</dd><dt id="sensor-vertical-binning"><a href="#toc">sensor-vertical-binning</a></dt>
+<dd><pre><code class="prop-type">"sensor-vertical-binning" : guint : Read / Write</code></pre>
+<p>Number of sensor ADCs that are combined to one pixel in vertical direction</p>
+</dd><dt id="sensor-vertical-binnings"><a href="#toc">sensor-vertical-binnings</a></dt>
+<dd><pre><code class="prop-type">"sensor-vertical-binnings" : GValueArray : Read-only</code></pre>
+<p>Array of possible binnings in vertical direction</p>
+</dd><dt id="sensor-max-frame-rate"><a href="#toc">sensor-max-frame-rate</a></dt>
+<dd><pre><code class="prop-type">"sensor-max-frame-rate" : gfloat : Read-only</code></pre>
+<p>Maximum frame rate at full frame resolution</p>
+</dd><dt id="trigger-mode"><a href="#toc">trigger-mode</a></dt>
+<dd><pre><code class="prop-type">"trigger-mode" : UcaCameraTrigger : Read / Write</code></pre>
+<p>Trigger mode</p>
+</dd><dt id="exposure-time"><a href="#toc">exposure-time</a></dt>
+<dd><pre><code class="prop-type">"exposure-time" : gdouble : Read / Write</code></pre>
+<p>Exposure time in seconds</p>
+</dd><dt id="roi-x0"><a href="#toc">roi-x0</a></dt>
+<dd><pre><code class="prop-type">"roi-x0" : guint : Read / Write</code></pre>
+<p>Horizontal coordinate</p>
+</dd><dt id="roi-y0"><a href="#toc">roi-y0</a></dt>
+<dd><pre><code class="prop-type">"roi-y0" : guint : Read / Write</code></pre>
+<p>Vertical coordinate</p>
+</dd><dt id="roi-width"><a href="#toc">roi-width</a></dt>
+<dd><pre><code class="prop-type">"roi-width" : guint : Read / Write</code></pre>
+<p>Width of the region of interest</p>
+</dd><dt id="roi-height"><a href="#toc">roi-height</a></dt>
+<dd><pre><code class="prop-type">"roi-height" : guint : Read / Write</code></pre>
+<p>Height of the region of interest</p>
+</dd><dt id="roi-width-multiplier"><a href="#toc">roi-width-multiplier</a></dt>
+<dd><pre><code class="prop-type">"roi-width-multiplier" : guint : Read-only</code></pre>
+<p>Minimum possible step size of horizontal ROI</p>
+</dd><dt id="roi-height-multiplier"><a href="#toc">roi-height-multiplier</a></dt>
+<dd><pre><code class="prop-type">"roi-height-multiplier" : guint : Read-only</code></pre>
+<p>Minimum possible step size of vertical ROI</p>
+</dd><dt id="has-streaming"><a href="#toc">has-streaming</a></dt>
+<dd><pre><code class="prop-type">"has-streaming" : gboolean : Read-only</code></pre>
+<p>Is the camera able to stream the data</p>
+</dd><dt id="has-camram-recording"><a href="#toc">has-camram-recording</a></dt>
+<dd><pre><code class="prop-type">"has-camram-recording" : gboolean : Read-only</code></pre>
+<p>Is the camera able to record the data in-camera</p>
+</dd><dt id="transfer-asynchronously"><a href="#toc">transfer-asynchronously</a></dt>
+<dd><pre><code class="prop-type">"transfer-asynchronously" : gboolean : Read / Write</code></pre>
+<p>Specify whether data should be transfered asynchronously using a specified callback</p>
+</dd><dt id="is-recording"><a href="#toc">is-recording</a></dt>
+<dd><pre><code class="prop-type">"is-recording" : gboolean : Read-only</code></pre>
+<p>Is the camera currently recording</p>
+</dd><dt id="is-readout"><a href="#toc">is-readout</a></dt>
+<dd><pre><code class="prop-type">"is-readout" : gboolean : Read-only</code></pre>
+<p>Is camera in readout mode</p>
+</dd></dl></body></html>
diff --git a/docs/manual.md b/docs/manual.md
index 91935cc..0fe4cca 100644
--- a/docs/manual.md
+++ b/docs/manual.md
@@ -247,8 +247,10 @@ The following cameras are supported:
## Property documentation
+* [Basic camera properties][base-doc]
* [mock][mock-doc]
+[base-doc]: base.html
[mock-doc]: mock.html
diff --git a/tools/gen-doc.c b/tools/gen-doc.c
index d9b6b41..86d6ff9 100644
--- a/tools/gen-doc.c
+++ b/tools/gen-doc.c
@@ -124,25 +124,29 @@ int main(int argc, char *argv[])
{
UcaPluginManager *manager;
UcaCamera *camera;
+ gchar *name;
GError *error = NULL;
g_type_init();
+ manager = uca_plugin_manager_new ();
if (argc < 2) {
- print_usage();
- return 1;
+ name = g_strdup ("Basic camera");
+ camera = g_object_new (UCA_TYPE_CAMERA, NULL);
+ }
+ else {
+ name = argv[1];
+ camera = uca_plugin_manager_new_camera (manager, name, &error);
}
-
- manager = uca_plugin_manager_new ();
- camera = uca_plugin_manager_new_camera (manager, argv[1], &error);
if (camera == NULL) {
g_print("Error during initialization: %s\n", error->message);
+ print_usage();
return 1;
}
- g_print (html_header, argv[1]);
- g_print ("<div id=\"header\"><h1 class=\"title\">Property documentation of %s</h1>", argv[1]);
+ g_print (html_header, name);
+ g_print ("<div id=\"header\"><h1 class=\"title\">Property documentation of %s</h1>", name);
print_properties (camera);
g_print ("%s\n", html_footer);
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-10 19:17:14 +0000