From: Ian Osgood <iano@quirkster.com>
Date: Sat, 7 Oct 2006 21:09:29 +0000 (-0700)
Subject: Document xcb_generate_id.
X-Git-Url: http://git.demorecorder.com/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7b84d8b650a611d4d76083340e50cb7ea815014d;p=free-sw%2Fxcb%2Flibxcb

Document xcb_generate_id.
---

diff --git a/src/xcb.h b/src/xcb.h
index eaab47f..751bf70 100644
--- a/src/xcb.h
+++ b/src/xcb.h
@@ -410,6 +410,14 @@ xcb_connection_t *xcb_connect_to_display_with_auth_info(const char *display, xcb
 
 /* xcb_xid.c */
 
+/**
+ * @brief Allocates an XID for a new object.
+ * @param c: The connection.
+ * @return A newly allocated XID.
+ *
+ * Allocates an XID for a new object. Typically used just prior to
+ * various object creation functions, such as xcb_create_window.
+ */
 uint32_t xcb_generate_id(xcb_connection_t *c);