summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorLutz Mueller <lutz@users.sourceforge.net>2002-02-06 13:15:05 +0000
committerLutz Mueller <lutz@users.sourceforge.net>2002-02-06 13:15:05 +0000
commit8dba175e71322ce997a32be6214547a587050303 (patch)
treefe116f1fc99d6591ac713bfa2213c1202c355b5c /doc/api
parenta360bc4dfaf749780e7f133dc6b8d5750e03391e (diff)
downloadlibgphoto2-8dba175e71322ce997a32be6214547a587050303.tar.gz
2002-02-06 Lutz M�ller <lutz@users.sourceforge.net>
* libgphoto2_port/m4/Documentation.m4: Fix copy & paste error * doc/api/Makefile.am * libgphoto2_port/doc/Makefile.am * libgphoto2_port/doc/DocRules.am: Fix --enable-docs git-svn-id: https://svn.code.sf.net/p/gphoto/code/trunk/libgphoto2@4085 67ed7778-7388-44ab-90cf-0a291f65f57c
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/Makefile.am2
-rw-r--r--doc/api/tmpl/gphoto2-abilities-list.sgml3
-rw-r--r--doc/api/tmpl/gphoto2-camera.sgml143
-rw-r--r--doc/api/tmpl/gphoto2-file.sgml17
-rw-r--r--doc/api/tmpl/gphoto2-filesys.sgml30
-rw-r--r--doc/api/tmpl/gphoto2-library.sgml2
-rw-r--r--doc/api/tmpl/gphoto2-unused.sgml113
7 files changed, 177 insertions, 133 deletions
diff --git a/doc/api/Makefile.am b/doc/api/Makefile.am
index 33716a363..86015b87a 100644
--- a/doc/api/Makefile.am
+++ b/doc/api/Makefile.am
@@ -4,7 +4,7 @@
DOC_MODULE=gphoto2
# The directory containing the source code (if it contains documentation).
-DOC_SOURCE_DIR=$(top_srcdir)/libgphoto2
+DOC_SOURCE_DIR=../../libgphoto2
# include common doc generation rules
include $(top_srcdir)/libgphoto2_port/doc/DocRules.am
diff --git a/doc/api/tmpl/gphoto2-abilities-list.sgml b/doc/api/tmpl/gphoto2-abilities-list.sgml
index bd6d2e56b..f83eb524d 100644
--- a/doc/api/tmpl/gphoto2-abilities-list.sgml
+++ b/doc/api/tmpl/gphoto2-abilities-list.sgml
@@ -85,6 +85,7 @@ order to set up a #Camera, you need to call #gp_camera_set_abilities. The
@GP_FILE_OPERATION_PREVIEW: The camera can supply previews of files.
@GP_FILE_OPERATION_RAW: The camera can supply raw data.
@GP_FILE_OPERATION_AUDIO: The camera supports audio annotations.
+@GP_FILE_OPERATION_EXIF:
<!-- ##### ENUM CameraFolderOperation ##### -->
<para>
@@ -140,6 +141,7 @@ order to set up a #Camera, you need to call #gp_camera_set_abilities. The
</para>
@list:
+@context:
@Returns:
@@ -151,6 +153,7 @@ order to set up a #Camera, you need to call #gp_camera_set_abilities. The
@list:
@info_list:
@l:
+@context:
@Returns:
diff --git a/doc/api/tmpl/gphoto2-camera.sgml b/doc/api/tmpl/gphoto2-camera.sgml
index 4d299d5b6..d1aaff0ca 100644
--- a/doc/api/tmpl/gphoto2-camera.sgml
+++ b/doc/api/tmpl/gphoto2-camera.sgml
@@ -69,6 +69,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
</para>
@camera: a #Camera
+@context:
@Returns: a GPhoto2 error code
@@ -80,6 +81,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera: a #Camera
@widget:
+@context:
@Returns: a GPhoto2 error code
@@ -94,6 +96,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera: a #Camera
@widget: a #CameraWidget created by #gp_camera_get_config
+@context:
@Returns: a GPhoto2 error code
@@ -111,6 +114,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera: a #Camera
@type: a #CameraCaptureType
@path: a #CameraFilePath
+@context:
@Returns: a GPhoto2 error code
@@ -124,6 +128,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera: a #Camera
@file: a #CameraFile
+@context:
@Returns: a GPhoto2 error code
@@ -137,6 +142,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera: a #Camera
@text: a #CameraText
+@context:
@Returns: a GPhoto2 error code
@@ -149,6 +155,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera: a #Camera
@text: a #CameraText
+@context:
@Returns: a GPhoto2 error code
@@ -160,6 +167,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera: a #Camera
@text: a #CameraText
+@context:
@Returns: a GPhoto2 error code
@@ -169,6 +177,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
</para>
@camera:
+@context:
@Returns:
@@ -255,121 +264,6 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@Returns:
-<!-- ##### USER_FUNCTION CameraStatusFunc ##### -->
-<para>
-
-</para>
-
-@Param1:
-@status:
-@data:
-
-
-<!-- ##### FUNCTION gp_camera_set_status_func ##### -->
-<para>
-
-</para>
-
-@camera:
-@func:
-@data:
-@Returns:
-
-
-<!-- ##### USER_FUNCTION CameraProgressFunc ##### -->
-<para>
-
-</para>
-
-@Param1:
-@percentage:
-@data:
-
-
-<!-- ##### FUNCTION gp_camera_set_progress_func ##### -->
-<para>
-
-</para>
-
-@camera:
-@func:
-@data:
-@Returns:
-
-
-<!-- ##### USER_FUNCTION CameraMessageFunc ##### -->
-<para>
-
-</para>
-
-@Param1:
-@msg:
-@data:
-
-
-<!-- ##### FUNCTION gp_camera_set_message_func ##### -->
-<para>
-
-</para>
-
-@camera:
-@func:
-@data:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_camera_set_error ##### -->
-<para>
-
-</para>
-
-@camera:
-@format:
-@Varargs:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_camera_get_error ##### -->
-<para>
-
-</para>
-
-@camera:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_camera_status ##### -->
-<para>
-
-</para>
-
-@camera:
-@format:
-@Varargs:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_camera_progress ##### -->
-<para>
-
-</para>
-
-@camera:
-@percentage:
-@Returns:
-
-
-<!-- ##### FUNCTION gp_camera_message ##### -->
-<para>
-
-</para>
-
-@camera:
-@format:
-@Varargs:
-@Returns:
-
-
<!-- ##### FUNCTION gp_camera_set_abilities ##### -->
<para>
@@ -435,6 +329,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
</para>
@camera:
+@context:
@Returns:
@@ -444,6 +339,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
</para>
@camera:
+@context:
@Returns:
@@ -470,6 +366,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@type:
@path:
+@context:
@Returns:
@@ -480,6 +377,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@file:
+@context:
@Returns:
@@ -490,6 +388,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@window:
+@context:
@Returns:
@@ -500,6 +399,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@window:
+@context:
@Returns:
@@ -511,6 +411,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@folder:
@list:
+@context:
@Returns:
@@ -522,6 +423,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@folder:
@list:
+@context:
@Returns:
@@ -533,6 +435,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@folder:
@file:
+@context:
@Returns:
@@ -543,6 +446,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@folder:
+@context:
@Returns:
@@ -554,6 +458,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@folder:
@name:
+@context:
@Returns:
@@ -565,6 +470,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@folder:
@name:
+@context:
@Returns:
@@ -578,6 +484,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@file:
@type:
@camera_file:
+@context:
@Returns:
@@ -589,6 +496,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@folder:
@file:
+@context:
@Returns:
@@ -601,6 +509,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@folder:
@file:
@info:
+@context:
@Returns:
@@ -613,6 +522,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@folder:
@file:
@info:
+@context:
@Returns:
@@ -623,6 +533,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@manual:
+@context:
@Returns:
@@ -633,6 +544,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@summary:
+@context:
@Returns:
@@ -643,6 +555,7 @@ Error reporting can be performed using #gp_camera_set_error and #gp_camera_get_e
@camera:
@about:
+@context:
@Returns:
diff --git a/doc/api/tmpl/gphoto2-file.sgml b/doc/api/tmpl/gphoto2-file.sgml
index 7884d5837..0ff506a8c 100644
--- a/doc/api/tmpl/gphoto2-file.sgml
+++ b/doc/api/tmpl/gphoto2-file.sgml
@@ -135,6 +135,7 @@ An abstraction of files
data format in order to be able to process the data.
@GP_FILE_TYPE_AUDIO: A file of this type contains audio data that is
connected to another file.
+@GP_FILE_TYPE_EXIF:
<!-- ##### FUNCTION gp_file_get_type ##### -->
<para>
@@ -303,16 +304,6 @@ An abstraction of files
@Returns:
-<!-- ##### FUNCTION gp_file_get_last_chunk ##### -->
-<para>
-
-</para>
-
-@Param1:
-@data:
-@Returns:
-
-
<!-- ##### FUNCTION gp_file_set_color_table ##### -->
<para>
@@ -366,9 +357,8 @@ An abstraction of files
@Param1:
@data:
-@Returns:
-<!-- # Unused Parameters # -->
@size:
+@Returns:
<!-- ##### FUNCTION gp_file_set_data_and_size ##### -->
@@ -378,8 +368,7 @@ An abstraction of files
@Param1:
@data:
-@Returns:
-<!-- # Unused Parameters # -->
@size:
+@Returns:
diff --git a/doc/api/tmpl/gphoto2-filesys.sgml b/doc/api/tmpl/gphoto2-filesys.sgml
index 91bc3b481..4f42b60cb 100644
--- a/doc/api/tmpl/gphoto2-filesys.sgml
+++ b/doc/api/tmpl/gphoto2-filesys.sgml
@@ -95,8 +95,7 @@ retreiving information about a file, etc.
@GP_FILE_INFO_HEIGHT: Indicates if height field is valid.
@GP_FILE_INFO_PERMISSIONS: Indicates if the permissions field is valid.
@GP_FILE_INFO_STATUS: Indicates if the status field is valid.
-@GP_FILE_INFO_TIME: Indicates if there is information about the creation time
- of a file available.
+@GP_FILE_INFO_MTIME:
@GP_FILE_INFO_ALL:
<!-- ##### STRUCT CameraFileInfoAudio ##### -->
@@ -134,7 +133,7 @@ retreiving information about a file, etc.
@width:
@height:
@status:
-@time:
+@mtime:
<!-- ##### STRUCT CameraFileInfo ##### -->
<para>
@@ -174,6 +173,7 @@ retreiving information about a file, etc.
@type:
@file:
@data:
+@context:
@Returns:
@@ -186,6 +186,7 @@ retreiving information about a file, etc.
@folder:
@filename:
@data:
+@context:
@Returns:
@@ -211,6 +212,7 @@ retreiving information about a file, etc.
@filename:
@info:
@data:
+@context:
@Returns:
@@ -224,6 +226,7 @@ retreiving information about a file, etc.
@filename:
@info:
@data:
+@context:
@Returns:
@@ -248,6 +251,7 @@ retreiving information about a file, etc.
@folder:
@file:
@data:
+@context:
@Returns:
@@ -259,6 +263,7 @@ retreiving information about a file, etc.
@fs:
@folder:
@data:
+@context:
@Returns:
@@ -271,6 +276,7 @@ retreiving information about a file, etc.
@folder:
@name:
@data:
+@context:
@Returns:
@@ -297,6 +303,7 @@ retreiving information about a file, etc.
@folder:
@list:
@data:
+@context:
@Returns:
@@ -320,6 +327,7 @@ retreiving information about a file, etc.
@fs:
@folder:
@list:
+@context:
@Returns:
@@ -331,6 +339,7 @@ retreiving information about a file, etc.
@fs:
@folder:
@list:
+@context:
@Returns:
@@ -344,6 +353,7 @@ retreiving information about a file, etc.
@filename:
@type:
@file:
+@context:
@Returns:
@@ -355,6 +365,7 @@ retreiving information about a file, etc.
@fs:
@folder:
@file:
+@context:
@Returns:
@@ -366,6 +377,7 @@ retreiving information about a file, etc.
@fs:
@folder:
@filename:
+@context:
@Returns:
@@ -376,6 +388,7 @@ retreiving information about a file, etc.
@fs:
@folder:
+@context:
@Returns:
@@ -387,6 +400,7 @@ retreiving information about a file, etc.
@fs:
@folder:
@name:
+@context:
@Returns:
@@ -398,6 +412,7 @@ retreiving information about a file, etc.
@fs:
@folder:
@name:
+@context:
@Returns:
@@ -410,6 +425,7 @@ retreiving information about a file, etc.
@folder:
@filename:
@info:
+@context:
@Returns:
@@ -422,6 +438,7 @@ retreiving information about a file, etc.
@folder:
@filename:
@info:
+@context:
@Returns:
@@ -433,6 +450,7 @@ retreiving information about a file, etc.
@fs:
@folder:
@info:
+@context:
@Returns:
@@ -444,6 +462,7 @@ retreiving information about a file, etc.
@fs:
@folder:
@filename:
+@context:
@Returns:
@@ -456,6 +475,7 @@ retreiving information about a file, etc.
@folder:
@filenumber:
@filename:
+@context:
@Returns:
@@ -467,6 +487,7 @@ retreiving information about a file, etc.
@fs:
@filename:
@folder:
+@context:
@Returns:
@@ -477,6 +498,7 @@ retreiving information about a file, etc.
@fs:
@folder:
+@context:
@Returns:
@@ -497,6 +519,7 @@ retreiving information about a file, etc.
@fs:
@folder:
@filename:
+@context:
@Returns:
@@ -508,6 +531,7 @@ retreiving information about a file, etc.
@fs:
@folder:
@file:
+@context:
@Returns:
diff --git a/doc/api/tmpl/gphoto2-library.sgml b/doc/api/tmpl/gphoto2-library.sgml
index 02d502ac8..ffb55c6f4 100644
--- a/doc/api/tmpl/gphoto2-library.sgml
+++ b/doc/api/tmpl/gphoto2-library.sgml
@@ -81,6 +81,7 @@ This section contains functions that have to be implemented by camera drivers.
</para>
@camera:
+@context:
@Returns:
<!-- # Unused Parameters # -->
@Param1:
@@ -110,6 +111,7 @@ This section contains functions that have to be implemented by camera drivers.
</para>
@camera:
+@context:
@Returns:
diff --git a/doc/api/tmpl/gphoto2-unused.sgml b/doc/api/tmpl/gphoto2-unused.sgml
index e163c5c8e..122c4b796 100644
--- a/doc/api/tmpl/gphoto2-unused.sgml
+++ b/doc/api/tmpl/gphoto2-unused.sgml
@@ -92,6 +92,24 @@ CameraAbilities
@widget:
@Returns:
+<!-- ##### USER_FUNCTION CameraMessageFunc ##### -->
+<para>
+
+</para>
+
+@Param1:
+@msg:
+@data:
+
+<!-- ##### USER_FUNCTION CameraProgressFunc ##### -->
+<para>
+
+</para>
+
+@Param1:
+@percentage:
+@data:
+
<!-- ##### USER_FUNCTION CameraResultFunc ##### -->
<para>
@@ -101,6 +119,15 @@ CameraAbilities
@result:
@Returns:
+<!-- ##### USER_FUNCTION CameraStatusFunc ##### -->
+<para>
+
+</para>
+
+@Param1:
+@status:
+@data:
+
<!-- ##### MACRO GP_ERROR_IO ##### -->
<para>
@@ -149,3 +176,89 @@ CameraAbilities
@window:
@Returns:
+<!-- ##### FUNCTION gp_camera_get_error ##### -->
+<para>
+
+</para>
+
+@camera:
+@Returns:
+
+<!-- ##### FUNCTION gp_camera_message ##### -->
+<para>
+
+</para>
+
+@camera:
+@format:
+@Varargs:
+@Returns:
+
+<!-- ##### FUNCTION gp_camera_progress ##### -->
+<para>
+
+</para>
+
+@camera:
+@percentage:
+@Returns:
+
+<!-- ##### FUNCTION gp_camera_set_error ##### -->
+<para>
+
+</para>
+
+@camera:
+@format:
+@Varargs:
+@Returns:
+
+<!-- ##### FUNCTION gp_camera_set_message_func ##### -->
+<para>
+
+</para>
+
+@camera:
+@func:
+@data:
+@Returns:
+
+<!-- ##### FUNCTION gp_camera_set_progress_func ##### -->
+<para>
+
+</para>
+
+@camera:
+@func:
+@data:
+@Returns:
+
+<!-- ##### FUNCTION gp_camera_set_status_func ##### -->
+<para>
+
+</para>
+
+@camera:
+@func:
+@data:
+@Returns:
+
+<!-- ##### FUNCTION gp_camera_status ##### -->
+<para>
+
+</para>
+
+@camera:
+@format:
+@Varargs:
+@Returns:
+
+<!-- ##### FUNCTION gp_file_get_last_chunk ##### -->
+<para>
+
+</para>
+
+@Param1:
+@data:
+@Returns:
+