summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid King <amigadave@amigadave.com>2011-10-30 16:26:22 +0100
committerDavid King <amigadave@amigadave.com>2011-10-30 16:31:55 +0100
commit691a7308a8960f13b18d67160828e5c68c515f00 (patch)
treefbb93e5a2b38d25e18b826cbf438de2a86a8737e /docs
parent33921aa1e73e7c19cf1bfc32ec8a90faa0a79f2d (diff)
downloadcheese-691a7308a8960f13b18d67160828e5c68c515f00.tar.gz
Improve documentation to pass gtk-doc tests
Add the deprecated API index to the documentation. Complete the rename of cheese_camera_set_device_by_dev_file() to cheese_camera_set_device_by_device_node(). Add missing documentation to reach 100% symbol coverage.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/cheese-docs.xml4
-rw-r--r--docs/reference/cheese-sections.txt2
2 files changed, 5 insertions, 1 deletions
diff --git a/docs/reference/cheese-docs.xml b/docs/reference/cheese-docs.xml
index 4face42f..de2d1fb6 100644
--- a/docs/reference/cheese-docs.xml
+++ b/docs/reference/cheese-docs.xml
@@ -57,6 +57,10 @@
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
+ <index id="api-index-deprecated" role="deprecated">
+ <title>Index of deprecated symbols</title>
+ <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ </index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>
diff --git a/docs/reference/cheese-sections.txt b/docs/reference/cheese-sections.txt
index 780191d3..15db465c 100644
--- a/docs/reference/cheese-sections.txt
+++ b/docs/reference/cheese-sections.txt
@@ -28,7 +28,7 @@ cheese_camera_get_current_video_format
cheese_camera_get_video_formats
cheese_camera_set_video_format
cheese_camera_get_selected_device
-cheese_camera_set_device_by_dev_file
+cheese_camera_set_device_by_device_node
cheese_camera_set_effect
cheese_camera_get_balance_property_range
cheese_camera_set_balance_property