From 24fef4062ad441c935f5a87e908c5f293d8a2f42 Mon Sep 17 00:00:00 2001 From: "Andrew Gallant (Ocelot)" Date: Sat, 12 May 2012 21:36:31 -0400 Subject: docs --- nexgb/xgb.go | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'nexgb/xgb.go') diff --git a/nexgb/xgb.go b/nexgb/xgb.go index 50cfdba..b2cf56c 100644 --- a/nexgb/xgb.go +++ b/nexgb/xgb.go @@ -166,8 +166,11 @@ type eventOrError interface{} // NewID generates a new unused ID for use with requests like CreateWindow. // If no new ids can be generated, the id returned is 0 and error is non-nil. -// Note that the value returned will need to be converted to the proper -// type. i.e., xproto.Window(id). +// This shouldn't be used directly, and is exported for use in the extension +// sub-packages. +// If you need identifiers, use the appropriate constructor. +// e.g., For a window id, use xproto.NewWindowId. For +// a new pixmap id, use xproto.NewPixmapId. And so on. func (c *Conn) NewId() (uint32, error) { xid := <-c.xidChan if xid.err != nil { -- cgit v1.2.3-70-g09d2