summaryrefslogtreecommitdiff
path: root/libcheese/cheese-camera-device.h
diff options
context:
space:
mode:
authorDavid King <amigadave@amigadave.com>2011-10-27 23:38:50 +0200
committerDavid King <amigadave@amigadave.com>2011-10-27 23:44:32 +0200
commitc197715d77184b07f86a14ef3584a20a54e223e4 (patch)
tree8abf030917a76f89cb13e929571a560583f7f0c4 /libcheese/cheese-camera-device.h
parentfb9e20ca79811711bc6374fc0b4a524f537caf9a (diff)
downloadcheese-c197715d77184b07f86a14ef3584a20a54e223e4.tar.gz
Overhaul the libcheese documentation
Add documentation for CheeseCameraDevice. Remove bogus XML included in the library overview. Add section documentation to all classes, and mark them as unstable. Add GObject and GObjectClass struct documentation.
Diffstat (limited to 'libcheese/cheese-camera-device.h')
-rw-r--r--libcheese/cheese-camera-device.h27
1 files changed, 21 insertions, 6 deletions
diff --git a/libcheese/cheese-camera-device.h b/libcheese/cheese-camera-device.h
index 843a28cc..6874b939 100644
--- a/libcheese/cheese-camera-device.h
+++ b/libcheese/cheese-camera-device.h
@@ -38,15 +38,30 @@ G_BEGIN_DECLS
#define CHEESE_CAMERA_DEVICE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), CHEESE_TYPE_CAMERA_DEVICE, \
CheeseCameraDeviceClass))
-typedef struct
-{
- GObject parent;
-} CheeseCameraDevice;
+typedef struct _CheeseCameraDeviceClass CheeseCameraDeviceClass;
+typedef struct _CheeseCameraDevice CheeseCameraDevice;
-typedef struct
+/**
+ * CheeseCameraDeviceClass:
+ *
+ * Use the accessor functions below.
+ */
+struct _CheeseCameraDeviceClass
{
+ /*< private >*/
GObjectClass parent_class;
-} CheeseCameraDeviceClass;
+};
+
+/**
+ * CheeseCameraDevice:
+ *
+ * Use the accessor functions below.
+ */
+struct _CheeseCameraDevice
+{
+ /*< private >*/
+ GObject parent;
+};
#define CHEESE_TYPE_VIDEO_FORMAT (cheese_video_format_get_type ())