From 8b2867b429fc3d725087c9c87835cc2eea9e734a Mon Sep 17 00:00:00 2001
From: Matthias Vogelgesang <matthias.vogelgesang@gmail.com>
Date: Thu, 19 Apr 2012 17:29:51 +0200
Subject: Add a bit of documentation

---
 src/CMakeLists.txt  |  6 ++++--
 src/uca-docs.xml.in | 24 ++++++++++++++++++++++++
 2 files changed, 28 insertions(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index a2d118e..308ab0a 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -44,6 +44,8 @@ if (PF_FOUND)
     if (HAVE_PHOTON_FOCUS AND CLSERME4_FOUND AND FGLIB5_FOUND)
         set(uca_SRCS ${uca_SRCS} cameras/uca-pf-camera.c)
         set(uca_HDRS ${uca_HDRS} cameras/uca-pf-camera.h)
+        list(APPEND cameras "Pf")
+
         set(uca_LIBS ${uca_LIBS} 
             ${CLSERME4_LIBRARY} 
             ${FGLIB5_LIBRARY} 
@@ -176,7 +178,7 @@ if(GTK_DOC_FOUND)
             COMMAND ${GTK_DOC_SCAN}
                     --module=uca
                     --source-dir=${CMAKE_CURRENT_SOURCE_DIR}
-                    DEPENDS ${uca_SRCS} 
+                    DEPENDS ${uca_SRCS}
             WORKING_DIRECTORY ${docs_out})
 
         add_custom_command(OUTPUT ${docs_out}/uca.args
@@ -196,7 +198,7 @@ if(GTK_DOC_FOUND)
             COMMAND ${GTK_DOC_MKHTML}
                     uca
                     ${docs_out}/uca-docs.xml
-            DEPENDS ${docs_out}/sgml.stamp
+            DEPENDS ${docs_out}/sgml.stamp ${docs_out}/uca-docs.xml
             WORKING_DIRECTORY ${docs_out})
 
         add_custom_target(reference ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/../html.stamp)
diff --git a/src/uca-docs.xml.in b/src/uca-docs.xml.in
index 8934ac2..60bcf57 100644
--- a/src/uca-docs.xml.in
+++ b/src/uca-docs.xml.in
@@ -20,6 +20,30 @@
         ${_xml_doc_input}
 
   </chapter>
+
+  <chapter id="howto-add-camera">
+      <title>How to add a new camera</title>
+
+      <para>
+          Adding a new camera involves three steps:
+          <itemizedlist>
+              <listitem><para>Subclass from <link linkend="UcaCamera">UcaCamera</link> and implement all necessary methods
+                  to start and stop recording, to grab frames and override and
+                  add properties that are special to your
+                  camera.</para></listitem>
+              <listitem><para>Adapt <filename>src/CMakeLists.txt</filename>, so
+                      that your dependencies are detected and your source files
+                      are added to the <literal>uca_SRCS</literal> CMake
+                      variable. Furthermore you must add an entry to
+                      <filename>src/config.h.in</filename> that reflects the
+                      CMake option variable</para></listitem>
+              <listitem><para>Change <filename>src/uca-camera.c</filename>
+                      and add a new (guarded) entry to the factory as well
+                      as necessary include files.</para></listitem>
+          </itemizedlist>
+      </para>
+  </chapter>
+
   <index id="api-index-full">
     <title>API Index</title>
     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
-- 
cgit v1.2.3