Document more structs

This commit is contained in:
Matthias Clasen 2017-12-26 14:39:24 -05:00
parent 53522f3c25
commit ca2a7c1efd
15 changed files with 111 additions and 1 deletions

View File

@ -55,6 +55,13 @@
* which provides a #GInputStream object. * which provides a #GInputStream object.
*/ */
/**
* GdkClipboard:
*
* The GdkClipboard struct contains only private fields and should not be
* accessed directly.
*/
typedef struct _GdkClipboardPrivate GdkClipboardPrivate; typedef struct _GdkClipboardPrivate GdkClipboardPrivate;
struct _GdkClipboardPrivate struct _GdkClipboardPrivate

View File

@ -38,6 +38,12 @@ G_BEGIN_DECLS
typedef struct _GdkContentProviderClass GdkContentProviderClass; typedef struct _GdkContentProviderClass GdkContentProviderClass;
/**
* GdkContentProvider:
*
* Should not be directly accessed.
*/
struct _GdkContentProvider struct _GdkContentProvider
{ {
GObject parent; GObject parent;

View File

@ -42,6 +42,13 @@
* relationships. * relationships.
*/ */
/**
* GdkDevice:
*
* The GdkDevice struct contains only private fields and
* should not be accessed directly.
*/
typedef struct _GdkAxisInfo GdkAxisInfo; typedef struct _GdkAxisInfo GdkAxisInfo;
struct _GdkAxisInfo struct _GdkAxisInfo

View File

@ -42,6 +42,13 @@
* *
*/ */
/**
* GdkDevicePad:
*
* The GdkDevicePad struct contains only private fields and
* should not be accessed directly.
*/
#include "config.h" #include "config.h"
#include "gdkdevicepad.h" #include "gdkdevicepad.h"

View File

@ -63,6 +63,12 @@
* with gdk-display_get_monitor() and similar APIs. * with gdk-display_get_monitor() and similar APIs.
*/ */
/**
* GdkDisplay:
*
* The GdkDisplay struct contains only private field and should not
* be accessed directly.
*/
enum enum
{ {
PROP_0, PROP_0,

View File

@ -109,6 +109,12 @@
* ]| * ]|
*/ */
/**
* GdkDisplayManager:
*
* The GdkDisplayManager struct contains only private fields and
* should not be accessed directly.
*/
enum { enum {
PROP_0, PROP_0,

View File

@ -84,6 +84,13 @@ static GList *contexts = NULL;
* the GTK+ documentation for more information. * the GTK+ documentation for more information.
*/ */
/**
* GdkDragContext:
*
* The GdkDragContext struct contains only private fields and
* should not be accessed directly.
*/
/** /**
* gdk_drag_context_get_display: * gdk_drag_context_get_display:
* @context: a #GdkDragContext * @context: a #GdkDragContext

View File

@ -34,8 +34,18 @@
* rendering methods, such as #GdkGLContext or #GdkVulkanContext. It provides * rendering methods, such as #GdkGLContext or #GdkVulkanContext. It provides
* shared functionality between those contexts. * shared functionality between those contexts.
* *
* You will always interact with one of those subclasses. * You will always interact with one of those s.ubclasses.
*
* A GdkDrawContext is always associated with a single toplevel window.
*/ */
/**
* GdkDrawContext:
*
* The GdkDrawContext struct contains only private fields and should not
* be accessed directly.
*/
typedef struct _GdkDrawContextPrivate GdkDrawContextPrivate; typedef struct _GdkDrawContextPrivate GdkDrawContextPrivate;
struct _GdkDrawContextPrivate { struct _GdkDrawContextPrivate {

View File

@ -32,6 +32,13 @@
* #GdkDrawingContext is available since GDK 3.22 * #GdkDrawingContext is available since GDK 3.22
*/ */
/**
* GdkDrawingContext:
*
* The GdkDrawingContext struct contains only private fields and should not
* be accessed directly.
*/
#include "config.h" #include "config.h"
#include <cairo-gobject.h> #include <cairo-gobject.h>

View File

@ -49,6 +49,19 @@
* so these functions are rarely needed. * so these functions are rarely needed.
*/ */
/**
* GdkEvent:
*
* The GdkEvent struct contains only private fields and
* should not be accessed directly.
*/
/**
* GdkEventSequence:
*
* GdkEventSequence is an opaque type representing a sequence
* of related touch events.
*/
typedef struct _GdkIOClosure GdkIOClosure; typedef struct _GdkIOClosure GdkIOClosure;

View File

@ -67,6 +67,13 @@
* they will stay exactly synchronized. * they will stay exactly synchronized.
*/ */
/**
* GdkFrameClock:
*
* The GdkFrameClock struct contains only private fields and
* should not be accessed directly.
*/
enum { enum {
FLUSH_EVENTS, FLUSH_EVENTS,
BEFORE_PAINT, BEFORE_PAINT,

View File

@ -34,6 +34,13 @@
* quality metrics for the applications display, such as latency and jitter. * quality metrics for the applications display, such as latency and jitter.
*/ */
/**
* GdkFrameTimings:
*
* The GdkFrameTimings struct contains only private fields and
* should not be accessed directly.
*/
G_DEFINE_BOXED_TYPE (GdkFrameTimings, gdk_frame_timings, G_DEFINE_BOXED_TYPE (GdkFrameTimings, gdk_frame_timings,
gdk_frame_timings_ref, gdk_frame_timings_ref,
gdk_frame_timings_unref) gdk_frame_timings_unref)

View File

@ -76,6 +76,13 @@
* that is currently set by calling gdk_gl_context_clear_current(). * that is currently set by calling gdk_gl_context_clear_current().
*/ */
/**
* GdkGLContext:
*
* The GdkGLContext struct contains only private fields and
* should not be accessed directly.
*/
#include "config.h" #include "config.h"
#include "gdkglcontextprivate.h" #include "gdkglcontextprivate.h"

View File

@ -36,6 +36,13 @@
* that belong to a user. * that belong to a user.
*/ */
/**
* GdkSeat:
*
* The GdkSeat struct contains only private fields and
* should not be accessed directly.
*/
typedef struct _GdkSeatPrivate GdkSeatPrivate; typedef struct _GdkSeatPrivate GdkSeatPrivate;
struct _GdkSeatPrivate struct _GdkSeatPrivate

View File

@ -68,6 +68,12 @@
* each #GtkButton has a #GdkWindow associated with it. * each #GtkButton has a #GdkWindow associated with it.
*/ */
/**
* GdkWindow:
*
* The GdkWindow struct contains only private fields and
* should not be accessed directly.
*/
/* Historically a GdkWindow always matches a platform native window, /* Historically a GdkWindow always matches a platform native window,
* be it a toplevel window or a child window. In this setup the * be it a toplevel window or a child window. In this setup the