libgimp*: lots of doc fixes and new docs for structs and enums
(cherry picked from commit aca5f806c4
)
This commit is contained in:
@ -88,7 +88,7 @@ gimp_busy_box_class_init (GimpBusyBoxClass *klass)
|
||||
* Specifies the displayed message.
|
||||
*
|
||||
* Since: 2.10.4
|
||||
*/
|
||||
**/
|
||||
g_object_class_install_property (object_class, PROP_MESSAGE,
|
||||
g_param_spec_string ("message",
|
||||
NULL, NULL,
|
||||
|
@ -55,6 +55,10 @@ struct _GimpBusyBoxClass
|
||||
void (* _gimp_reserved2) (void);
|
||||
void (* _gimp_reserved3) (void);
|
||||
void (* _gimp_reserved4) (void);
|
||||
void (* _gimp_reserved5) (void);
|
||||
void (* _gimp_reserved6) (void);
|
||||
void (* _gimp_reserved7) (void);
|
||||
void (* _gimp_reserved8) (void);
|
||||
};
|
||||
|
||||
|
||||
|
@ -50,6 +50,15 @@ typedef struct _GimpControllerEventTrigger GimpControllerEventTrigger;
|
||||
typedef struct _GimpControllerEventValue GimpControllerEventValue;
|
||||
typedef union _GimpControllerEvent GimpControllerEvent;
|
||||
|
||||
/**
|
||||
* GimpControllerEventAny:
|
||||
* @type: The event's #GimpControllerEventType
|
||||
* @source: The event's source #GimpController
|
||||
* @event_id: The event's ID
|
||||
*
|
||||
* Generic controller event. Every event has these three members at the
|
||||
* beginning of its struct
|
||||
**/
|
||||
struct _GimpControllerEventAny
|
||||
{
|
||||
GimpControllerEventType type;
|
||||
@ -57,6 +66,14 @@ struct _GimpControllerEventAny
|
||||
gint event_id;
|
||||
};
|
||||
|
||||
/**
|
||||
* GimpControllerEventTrigger:
|
||||
* @type: The event's #GimpControllerEventType
|
||||
* @source: The event's source #GimpController
|
||||
* @event_id: The event's ID
|
||||
*
|
||||
* Trigger controller event.
|
||||
**/
|
||||
struct _GimpControllerEventTrigger
|
||||
{
|
||||
GimpControllerEventType type;
|
||||
@ -64,6 +81,15 @@ struct _GimpControllerEventTrigger
|
||||
gint event_id;
|
||||
};
|
||||
|
||||
/**
|
||||
* GimpControllerEventValue:
|
||||
* @type: The event's #GimpControllerEventType
|
||||
* @source: The event's source #GimpController
|
||||
* @event_id: The event's ID
|
||||
* @value: The event's value
|
||||
*
|
||||
* Value controller event.
|
||||
**/
|
||||
struct _GimpControllerEventValue
|
||||
{
|
||||
GimpControllerEventType type;
|
||||
@ -72,6 +98,15 @@ struct _GimpControllerEventValue
|
||||
GValue value;
|
||||
};
|
||||
|
||||
/**
|
||||
* GimpControllerEvent:
|
||||
* @type: The event type
|
||||
* @any: GimpControllerEventAny
|
||||
* @trigger: GimpControllerEventTrigger
|
||||
* @value: GimpControllerEventValue
|
||||
*
|
||||
* A union to hjold all event event types
|
||||
**/
|
||||
union _GimpControllerEvent
|
||||
{
|
||||
GimpControllerEventType type;
|
||||
|
@ -29,6 +29,12 @@
|
||||
G_BEGIN_DECLS
|
||||
|
||||
|
||||
/**
|
||||
* GimpWidgetsError:
|
||||
* @GIMP_WIDGETS_PARSE_ERROR: A parse error has occured
|
||||
*
|
||||
* Types of errors returned by libgimpwidgets functions
|
||||
**/
|
||||
typedef enum
|
||||
{
|
||||
GIMP_WIDGETS_PARSE_ERROR
|
||||
|
Reference in New Issue
Block a user