From 53cb646dee0c170f8517e92c7693cc04b636c3ff Mon Sep 17 00:00:00 2001 From: Matthias Vogelgesang Date: Fri, 26 Oct 2012 17:12:13 +0200 Subject: Update documentation and release 1.1 --- docs/Makefile | 12 +- docs/gen-changelog | 20 ---- docs/manual.md | 16 ++- docs/pf.html | 73 +++++++++++ docs/ufo.html | 346 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 433 insertions(+), 34 deletions(-) delete mode 100755 docs/gen-changelog create mode 100644 docs/pf.html create mode 100644 docs/ufo.html (limited to 'docs') diff --git a/docs/Makefile b/docs/Makefile index ff7113d..53dc6fd 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -10,15 +10,11 @@ html: manual.html clean: rm -f manual.pdf manual.html -manual.pdf: manual.md gen-changelog - ./gen-changelog - $(PANDOC) $(OPTS) manual.md z-changes-*.md -o manual.pdf - rm z-changes-*.md +manual.pdf: manual.md + $(PANDOC) $(OPTS) manual.md -o manual.pdf -manual.html: manual.md style.css gen-changelog - ./gen-changelog - $(PANDOC) $(OPTS) manual.md z-changes-*.md -H webfonts.html -c style.css -o manual.html - rm z-changes-*.md +manual.html: manual.md style.css + $(PANDOC) $(OPTS) manual.md -H webfonts.html -c style.css -o manual.html ifeq ($(PANDOC),) $(warning Pandoc not found!) diff --git a/docs/gen-changelog b/docs/gen-changelog deleted file mode 100755 index 51650f1..0000000 --- a/docs/gen-changelog +++ /dev/null @@ -1,20 +0,0 @@ -#!/bin/bash - -FROM=$1 -TO=$2 -OUTPUT=$3 -series=('v1.0' 'v1.0.1') - -logname="z-changes-${series[0]}.md" - -echo "## Changes for stable branch ${series[0]} -" >> $logname - -for ((i = 1; i < ${#series[@]}; i++)) do - curr=${series[i]} - prev=${series[i-1]} - - echo "### Changes from $prev to $curr -" >> $logname - git log --pretty=format:'* [%h](http://ufo.kit.edu/repos/libuca.git/commit/?id=%h): %s' $prev..$curr >> $logname -done diff --git a/docs/manual.md b/docs/manual.md index a68400e..0dd9c66 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -236,6 +236,10 @@ In a similar way, properties are set with `g_object_set`: NULL); ~~~ +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`][ucacam-ref]. For camera specific parameters you need to consult the corresponding API reference @@ -259,13 +263,15 @@ The following cameras are supported: ## Property documentation -* [Basic camera properties][base-doc] -* [pco][pco-doc] * [mock][mock-doc] +* [pco][pco-doc] +* [PhotonFocus][pf-doc] +* [Ufo Camera][ufo-doc] -[base-doc]: base.html -[pco-doc]: pco.html [mock-doc]: mock.html +[pco-doc]: pco.html +[pf-doc]: pf.html +[ufo-doc]: ufo.html # More API @@ -490,5 +496,3 @@ grabbing time: [TODO: Get more information from Volker Kaiser and/or Mihael Koep] - -# ChangeLog diff --git a/docs/pf.html b/docs/pf.html new file mode 100644 index 0000000..8471c3f --- /dev/null +++ b/docs/pf.html @@ -0,0 +1,73 @@ +pf — properties