From 4e78a33ab00c8437d341a4cb83919e2a67e54493 Mon Sep 17 00:00:00 2001 From: Matthias Vogelgesang Date: Mon, 8 Oct 2012 10:04:18 +0200 Subject: Generate documentation for the base camera object --- docs/base.html | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ docs/manual.md | 2 ++ tools/gen-doc.c | 18 ++++++++++------ 3 files changed, 80 insertions(+), 7 deletions(-) create mode 100644 docs/base.html 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 @@ +Basic camera — properties

Property documentation of Basic camera

Properties

Details

name

"name" : gchararray : Read-only

Name of the camera

sensor-width

"sensor-width" : guint : Read-only

Width of the sensor in pixels

sensor-height

"sensor-height" : guint : Read-only

Height of the sensor in pixels

sensor-bitdepth

"sensor-bitdepth" : guint : Read-only

Number of bits per pixel

sensor-horizontal-binning

"sensor-horizontal-binning" : guint : Read / Write

Number of sensor ADCs that are combined to one pixel in horizontal direction

sensor-horizontal-binnings

"sensor-horizontal-binnings" : GValueArray : Read-only

Array of possible binnings in horizontal direction

sensor-vertical-binning

"sensor-vertical-binning" : guint : Read / Write

Number of sensor ADCs that are combined to one pixel in vertical direction

sensor-vertical-binnings

"sensor-vertical-binnings" : GValueArray : Read-only

Array of possible binnings in vertical direction

sensor-max-frame-rate

"sensor-max-frame-rate" : gfloat : Read-only

Maximum frame rate at full frame resolution

trigger-mode

"trigger-mode" : UcaCameraTrigger : Read / Write

Trigger mode

exposure-time

"exposure-time" : gdouble : Read / Write

Exposure time in seconds

roi-x0

"roi-x0" : guint : Read / Write

Horizontal coordinate

roi-y0

"roi-y0" : guint : Read / Write

Vertical coordinate

roi-width

"roi-width" : guint : Read / Write

Width of the region of interest

roi-height

"roi-height" : guint : Read / Write

Height of the region of interest

roi-width-multiplier

"roi-width-multiplier" : guint : Read-only

Minimum possible step size of horizontal ROI

roi-height-multiplier

"roi-height-multiplier" : guint : Read-only

Minimum possible step size of vertical ROI

has-streaming

"has-streaming" : gboolean : Read-only

Is the camera able to stream the data

has-camram-recording

"has-camram-recording" : gboolean : Read-only

Is the camera able to record the data in-camera

transfer-asynchronously

"transfer-asynchronously" : gboolean : Read / Write

Specify whether data should be transfered asynchronously using a specified callback

is-recording

"is-recording" : gboolean : Read-only

Is the camera currently recording

is-readout

"is-readout" : gboolean : Read-only

Is camera in readout mode

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 ("

Property documentation of Basic camera

Properties

Details

Property documentation of %s

Property documentation of %s