diff options
| author | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2014-07-11 11:10:47 +0200 |
|---|---|---|
| committer | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2014-07-11 11:10:47 +0200 |
| commit | 32c8dc2140ef0e106df97c9103207fcf7680ed9b (patch) | |
| tree | 8e9340a1bfb83303d91d1f6310ccc4a3ad2b0563 /docs | |
| parent | 4709b35fa44bcd518154165d5671c69c9c6653bb (diff) | |
| download | libuca-32c8dc2140ef0e106df97c9103207fcf7680ed9b.tar.gz libuca-32c8dc2140ef0e106df97c9103207fcf7680ed9b.tar.bz2 libuca-32c8dc2140ef0e106df97c9103207fcf7680ed9b.tar.xz libuca-32c8dc2140ef0e106df97c9103207fcf7680ed9b.zip | |
Fix some minor doc problems
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 2 | ||||
| -rw-r--r-- | docs/quickstart.rst | 7 | ||||
| -rw-r--r-- | docs/tools.rst | 12 |
3 files changed, 8 insertions, 13 deletions
diff --git a/docs/api.rst b/docs/api.rst index 8bb26b9..46318c7 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,6 +1,8 @@ Application Programming Interface ================================= +.. highlight:: c + In the introduction we had a quick glance over the basic API used to communicate with a camera. Now we will go into more detail and explain required background to understand the execution model. diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 59cb01e..1ad6b6f 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -219,10 +219,3 @@ In a similar way, properties are set with ``g_object_set``:: Each property can be associated with a physical unit. To query for the unit call ``uca_camera_get_unit`` and pass a property name. The function will then return a value from the ``UcaUnit`` enum. - -Several essential camera parameters *must* be implemented by all -cameras. To get a list of them consult the API reference for -```UcaCamera`` <http://ufo.kit.edu/extra/libuca/reference/UcaCamera.html#UcaCamera.properties>`__. -For camera specific parameters you need to consult the corresponding API -reference for ``UfoFooCamera``. The latest nightly built reference can -be found `here <http://ufo.kit.edu/extra/libuca/reference/>`__. diff --git a/docs/tools.rst b/docs/tools.rst index 44573eb..4197cc3 100644 --- a/docs/tools.rst +++ b/docs/tools.rst @@ -6,8 +6,8 @@ of them are located in ``build/test/`` and some of them are installed with ``make installed``. -``uca-camera-control`` -- simple graphical user interface ---------------------------------------------------------- +uca-camera-control -- simple graphical user interface +----------------------------------------------------- Records and shows frames. Moreover, you can change the camera properties in a side pane: @@ -15,8 +15,8 @@ side pane: .. image:: uca-gui.png -``uca-grab`` -- grabbing frames -------------------------------- +uca-grab -- grabbing frames +--------------------------- Grab with frames with :: @@ -37,8 +37,8 @@ in fractions of seconds:: $ uca-grab --duration=0.25 camera-model -``uca-benchmark`` -- check bandwidth ------------------------------------- +uca-benchmark -- check bandwidth +-------------------------------- Measure the memory bandwidth by taking subsequent frames and averaging the grabbing time:: |