better docs

1 files changed, 71 insertions, 55 deletions

diff --git a/nexgb/xinerama/xinerama.go b/nexgb/xinerama/xinerama.go
index 587b628..cc4eaaa 100644
--- a/nexgb/xinerama/xinerama.go
+++ b/nexgb/xinerama/xinerama.go
@@ -2,7 +2,7 @@
 package xinerama
 
 /*
-	This file was generated by xinerama.xml on May 10 2012 8:04:32pm EDT.
+	This file was generated by xinerama.xml on May 10 2012 11:56:19pm EDT.
 	This file is automatically generated. Edit at your peril!
 */
 
@@ -64,8 +64,6 @@ func init() {
 
 // Skipping definition for base type 'Card8'
 
-// 'ScreenInfo' struct definition
-// Size: 8
 type ScreenInfo struct {
 	XOrg   int16
 	YOrg   int16
@@ -73,7 +71,7 @@ type ScreenInfo struct {
 	Height uint16
 }
 
-// Struct read ScreenInfo
+// ScreenInfoRead reads a byte slice into a ScreenInfo value.
 func ScreenInfoRead(buf []byte, v *ScreenInfo) int {
 	b := 0
 
@@ -92,7 +90,7 @@ func ScreenInfoRead(buf []byte, v *ScreenInfo) int {
 	return b
 }
 
-// Struct list read ScreenInfo
+// ScreenInfoReadList reads a byte slice into a list of ScreenInfo values.
 func ScreenInfoReadList(buf []byte, dest []ScreenInfo) int {
 	b := 0
 	for i := 0; i < len(dest); i++ {
@@ -102,7 +100,7 @@ func ScreenInfoReadList(buf []byte, dest []ScreenInfo) int {
 	return xgb.Pad(b)
 }
 
-// Struct write ScreenInfo
+// Bytes writes a ScreenInfo value to a byte slice.
 func (v ScreenInfo) Bytes() []byte {
 	buf := make([]byte, 8)
 	b := 0
@@ -122,7 +120,7 @@ func (v ScreenInfo) Bytes() []byte {
 	return buf
 }
 
-// Write struct list ScreenInfo
+// ScreenInfoListBytes writes a list of %s(MISSING) values to a byte slice.
 func ScreenInfoListBytes(buf []byte, list []ScreenInfo) int {
 	b := 0
 	var structBytes []byte
@@ -134,35 +132,37 @@ func ScreenInfoListBytes(buf []byte, list []ScreenInfo) int {
 	return b
 }
 
-// Request QueryVersion
-// size: 8
+// QueryVersionCookie is a cookie used only for QueryVersion requests.
 type QueryVersionCookie struct {
 	*xgb.Cookie
 }
 
+// QueryVersion sends a checked request.
+// If an error occurs, it will be returned with the reply by calling QueryVersionCookie.Reply()
 func QueryVersion(c *xgb.Conn, Major byte, Minor byte) QueryVersionCookie {
 	cookie := c.NewCookie(true, true)
 	c.NewRequest(queryVersionRequest(c, Major, Minor), cookie)
 	return QueryVersionCookie{cookie}
 }
 
+// QueryVersionUnchecked sends an unchecked request.
+// If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.
 func QueryVersionUnchecked(c *xgb.Conn, Major byte, Minor byte) QueryVersionCookie {
 	cookie := c.NewCookie(false, true)
 	c.NewRequest(queryVersionRequest(c, Major, Minor), cookie)
 	return QueryVersionCookie{cookie}
 }
 
-// Request reply for QueryVersion
-// size: 12
+// QueryVersionReply represents the data returned from a QueryVersion request.
 type QueryVersionReply struct {
-	Sequence uint16
-	Length   uint32
+	Sequence uint16 // sequence number of the request for this reply
+	Length   uint32 // number of bytes in this reply
 	// padding: 1 bytes
 	Major uint16
 	Minor uint16
 }
 
-// Waits and reads reply data from request QueryVersion
+// Reply blocks and returns the reply data for a QueryVersion request.
 func (cook QueryVersionCookie) Reply() (*QueryVersionReply, error) {
 	buf, err := cook.Cookie.Reply()
 	if err != nil {
@@ -174,7 +174,7 @@ func (cook QueryVersionCookie) Reply() (*QueryVersionReply, error) {
 	return queryVersionReply(buf), nil
 }
 
-// Read reply into structure from buffer for QueryVersion
+// queryVersionReply reads a byte slice into a QueryVersionReply value.
 func queryVersionReply(buf []byte) *QueryVersionReply {
 	v := new(QueryVersionReply)
 	b := 1 // skip reply determinant
@@ -197,6 +197,7 @@ func queryVersionReply(buf []byte) *QueryVersionReply {
 }
 
 // Write request to wire for QueryVersion
+// queryVersionRequest writes a QueryVersion request to a byte slice.
 func queryVersionRequest(c *xgb.Conn, Major byte, Minor byte) []byte {
 	size := 8
 	b := 0
@@ -220,34 +221,36 @@ func queryVersionRequest(c *xgb.Conn, Major byte, Minor byte) []byte {
 	return buf
 }
 
-// Request GetState
-// size: 8
+// GetStateCookie is a cookie used only for GetState requests.
 type GetStateCookie struct {
 	*xgb.Cookie
 }
 
+// GetState sends a checked request.
+// If an error occurs, it will be returned with the reply by calling GetStateCookie.Reply()
 func GetState(c *xgb.Conn, Window xproto.Window) GetStateCookie {
 	cookie := c.NewCookie(true, true)
 	c.NewRequest(getStateRequest(c, Window), cookie)
 	return GetStateCookie{cookie}
 }
 
+// GetStateUnchecked sends an unchecked request.
+// If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.
 func GetStateUnchecked(c *xgb.Conn, Window xproto.Window) GetStateCookie {
 	cookie := c.NewCookie(false, true)
 	c.NewRequest(getStateRequest(c, Window), cookie)
 	return GetStateCookie{cookie}
 }
 
-// Request reply for GetState
-// size: 12
+// GetStateReply represents the data returned from a GetState request.
 type GetStateReply struct {
-	Sequence uint16
-	Length   uint32
+	Sequence uint16 // sequence number of the request for this reply
+	Length   uint32 // number of bytes in this reply
 	State    byte
 	Window   xproto.Window
 }
 
-// Waits and reads reply data from request GetState
+// Reply blocks and returns the reply data for a GetState request.
 func (cook GetStateCookie) Reply() (*GetStateReply, error) {
 	buf, err := cook.Cookie.Reply()
 	if err != nil {
@@ -259,7 +262,7 @@ func (cook GetStateCookie) Reply() (*GetStateReply, error) {
 	return getStateReply(buf), nil
 }
 
-// Read reply into structure from buffer for GetState
+// getStateReply reads a byte slice into a GetStateReply value.
 func getStateReply(buf []byte) *GetStateReply {
 	v := new(GetStateReply)
 	b := 1 // skip reply determinant
@@ -280,6 +283,7 @@ func getStateReply(buf []byte) *GetStateReply {
 }
 
 // Write request to wire for GetState
+// getStateRequest writes a GetState request to a byte slice.
 func getStateRequest(c *xgb.Conn, Window xproto.Window) []byte {
 	size := 8
 	b := 0
@@ -300,34 +304,36 @@ func getStateRequest(c *xgb.Conn, Window xproto.Window) []byte {
 	return buf
 }
 
-// Request GetScreenCount
-// size: 8
+// GetScreenCountCookie is a cookie used only for GetScreenCount requests.
 type GetScreenCountCookie struct {
 	*xgb.Cookie
 }
 
+// GetScreenCount sends a checked request.
+// If an error occurs, it will be returned with the reply by calling GetScreenCountCookie.Reply()
 func GetScreenCount(c *xgb.Conn, Window xproto.Window) GetScreenCountCookie {
 	cookie := c.NewCookie(true, true)
 	c.NewRequest(getScreenCountRequest(c, Window), cookie)
 	return GetScreenCountCookie{cookie}
 }
 
+// GetScreenCountUnchecked sends an unchecked request.
+// If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.
 func GetScreenCountUnchecked(c *xgb.Conn, Window xproto.Window) GetScreenCountCookie {
 	cookie := c.NewCookie(false, true)
 	c.NewRequest(getScreenCountRequest(c, Window), cookie)
 	return GetScreenCountCookie{cookie}
 }
 
-// Request reply for GetScreenCount
-// size: 12
+// GetScreenCountReply represents the data returned from a GetScreenCount request.
 type GetScreenCountReply struct {
-	Sequence    uint16
-	Length      uint32
+	Sequence    uint16 // sequence number of the request for this reply
+	Length      uint32 // number of bytes in this reply
 	ScreenCount byte
 	Window      xproto.Window
 }
 
-// Waits and reads reply data from request GetScreenCount
+// Reply blocks and returns the reply data for a GetScreenCount request.
 func (cook GetScreenCountCookie) Reply() (*GetScreenCountReply, error) {
 	buf, err := cook.Cookie.Reply()
 	if err != nil {
@@ -339,7 +345,7 @@ func (cook GetScreenCountCookie) Reply() (*GetScreenCountReply, error) {
 	return getScreenCountReply(buf), nil
 }
 
-// Read reply into structure from buffer for GetScreenCount
+// getScreenCountReply reads a byte slice into a GetScreenCountReply value.
 func getScreenCountReply(buf []byte) *GetScreenCountReply {
 	v := new(GetScreenCountReply)
 	b := 1 // skip reply determinant
@@ -360,6 +366,7 @@ func getScreenCountReply(buf []byte) *GetScreenCountReply {
 }
 
 // Write request to wire for GetScreenCount
+// getScreenCountRequest writes a GetScreenCount request to a byte slice.
 func getScreenCountRequest(c *xgb.Conn, Window xproto.Window) []byte {
 	size := 8
 	b := 0
@@ -380,29 +387,31 @@ func getScreenCountRequest(c *xgb.Conn, Window xproto.Window) []byte {
 	return buf
 }
 
-// Request GetScreenSize
-// size: 12
+// GetScreenSizeCookie is a cookie used only for GetScreenSize requests.
 type GetScreenSizeCookie struct {
 	*xgb.Cookie
 }
 
+// GetScreenSize sends a checked request.
+// If an error occurs, it will be returned with the reply by calling GetScreenSizeCookie.Reply()
 func GetScreenSize(c *xgb.Conn, Window xproto.Window, Screen uint32) GetScreenSizeCookie {
 	cookie := c.NewCookie(true, true)
 	c.NewRequest(getScreenSizeRequest(c, Window, Screen), cookie)
 	return GetScreenSizeCookie{cookie}
 }
 
+// GetScreenSizeUnchecked sends an unchecked request.
+// If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.
 func GetScreenSizeUnchecked(c *xgb.Conn, Window xproto.Window, Screen uint32) GetScreenSizeCookie {
 	cookie := c.NewCookie(false, true)
 	c.NewRequest(getScreenSizeRequest(c, Window, Screen), cookie)
 	return GetScreenSizeCookie{cookie}
 }
 
-// Request reply for GetScreenSize
-// size: 24
+// GetScreenSizeReply represents the data returned from a GetScreenSize request.
 type GetScreenSizeReply struct {
-	Sequence uint16
-	Length   uint32
+	Sequence uint16 // sequence number of the request for this reply
+	Length   uint32 // number of bytes in this reply
 	// padding: 1 bytes
 	Width  uint32
 	Height uint32
@@ -410,7 +419,7 @@ type GetScreenSizeReply struct {
 	Screen uint32
 }
 
-// Waits and reads reply data from request GetScreenSize
+// Reply blocks and returns the reply data for a GetScreenSize request.
 func (cook GetScreenSizeCookie) Reply() (*GetScreenSizeReply, error) {
 	buf, err := cook.Cookie.Reply()
 	if err != nil {
@@ -422,7 +431,7 @@ func (cook GetScreenSizeCookie) Reply() (*GetScreenSizeReply, error) {
 	return getScreenSizeReply(buf), nil
 }
 
-// Read reply into structure from buffer for GetScreenSize
+// getScreenSizeReply reads a byte slice into a GetScreenSizeReply value.
 func getScreenSizeReply(buf []byte) *GetScreenSizeReply {
 	v := new(GetScreenSizeReply)
 	b := 1 // skip reply determinant
@@ -451,6 +460,7 @@ func getScreenSizeReply(buf []byte) *GetScreenSizeReply {
 }
 
 // Write request to wire for GetScreenSize
+// getScreenSizeRequest writes a GetScreenSize request to a byte slice.
 func getScreenSizeRequest(c *xgb.Conn, Window xproto.Window, Screen uint32) []byte {
 	size := 12
 	b := 0
@@ -474,34 +484,36 @@ func getScreenSizeRequest(c *xgb.Conn, Window xproto.Window, Screen uint32) []by
 	return buf
 }
 
-// Request IsActive
-// size: 4
+// IsActiveCookie is a cookie used only for IsActive requests.
 type IsActiveCookie struct {
 	*xgb.Cookie
 }
 
+// IsActive sends a checked request.
+// If an error occurs, it will be returned with the reply by calling IsActiveCookie.Reply()
 func IsActive(c *xgb.Conn) IsActiveCookie {
 	cookie := c.NewCookie(true, true)
 	c.NewRequest(isActiveRequest(c), cookie)
 	return IsActiveCookie{cookie}
 }
 
+// IsActiveUnchecked sends an unchecked request.
+// If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.
 func IsActiveUnchecked(c *xgb.Conn) IsActiveCookie {
 	cookie := c.NewCookie(false, true)
 	c.NewRequest(isActiveRequest(c), cookie)
 	return IsActiveCookie{cookie}
 }
 
-// Request reply for IsActive
-// size: 12
+// IsActiveReply represents the data returned from a IsActive request.
 type IsActiveReply struct {
-	Sequence uint16
-	Length   uint32
+	Sequence uint16 // sequence number of the request for this reply
+	Length   uint32 // number of bytes in this reply
 	// padding: 1 bytes
 	State uint32
 }
 
-// Waits and reads reply data from request IsActive
+// Reply blocks and returns the reply data for a IsActive request.
 func (cook IsActiveCookie) Reply() (*IsActiveReply, error) {
 	buf, err := cook.Cookie.Reply()
 	if err != nil {
@@ -513,7 +525,7 @@ func (cook IsActiveCookie) Reply() (*IsActiveReply, error) {
 	return isActiveReply(buf), nil
 }
 
-// Read reply into structure from buffer for IsActive
+// isActiveReply reads a byte slice into a IsActiveReply value.
 func isActiveReply(buf []byte) *IsActiveReply {
 	v := new(IsActiveReply)
 	b := 1 // skip reply determinant
@@ -533,6 +545,7 @@ func isActiveReply(buf []byte) *IsActiveReply {
 }
 
 // Write request to wire for IsActive
+// isActiveRequest writes a IsActive request to a byte slice.
 func isActiveRequest(c *xgb.Conn) []byte {
 	size := 4
 	b := 0
@@ -550,36 +563,38 @@ func isActiveRequest(c *xgb.Conn) []byte {
 	return buf
 }
 
-// Request QueryScreens
-// size: 4
+// QueryScreensCookie is a cookie used only for QueryScreens requests.
 type QueryScreensCookie struct {
 	*xgb.Cookie
 }
 
+// QueryScreens sends a checked request.
+// If an error occurs, it will be returned with the reply by calling QueryScreensCookie.Reply()
 func QueryScreens(c *xgb.Conn) QueryScreensCookie {
 	cookie := c.NewCookie(true, true)
 	c.NewRequest(queryScreensRequest(c), cookie)
 	return QueryScreensCookie{cookie}
 }
 
+// QueryScreensUnchecked sends an unchecked request.
+// If an error occurs, it can only be retrieved using xgb.WaitForEvent or xgb.PollForEvent.
 func QueryScreensUnchecked(c *xgb.Conn) QueryScreensCookie {
 	cookie := c.NewCookie(false, true)
 	c.NewRequest(queryScreensRequest(c), cookie)
 	return QueryScreensCookie{cookie}
 }
 
-// Request reply for QueryScreens
-// size: (32 + xgb.Pad((int(Number) * 8)))
+// QueryScreensReply represents the data returned from a QueryScreens request.
 type QueryScreensReply struct {
-	Sequence uint16
-	Length   uint32
+	Sequence uint16 // sequence number of the request for this reply
+	Length   uint32 // number of bytes in this reply
 	// padding: 1 bytes
 	Number uint32
 	// padding: 20 bytes
 	ScreenInfo []ScreenInfo // size: xgb.Pad((int(Number) * 8))
 }
 
-// Waits and reads reply data from request QueryScreens
+// Reply blocks and returns the reply data for a QueryScreens request.
 func (cook QueryScreensCookie) Reply() (*QueryScreensReply, error) {
 	buf, err := cook.Cookie.Reply()
 	if err != nil {
@@ -591,7 +606,7 @@ func (cook QueryScreensCookie) Reply() (*QueryScreensReply, error) {
 	return queryScreensReply(buf), nil
 }
 
-// Read reply into structure from buffer for QueryScreens
+// queryScreensReply reads a byte slice into a QueryScreensReply value.
 func queryScreensReply(buf []byte) *QueryScreensReply {
 	v := new(QueryScreensReply)
 	b := 1 // skip reply determinant
@@ -616,6 +631,7 @@ func queryScreensReply(buf []byte) *QueryScreensReply {
 }
 
 // Write request to wire for QueryScreens
+// queryScreensRequest writes a QueryScreens request to a byte slice.
 func queryScreensRequest(c *xgb.Conn) []byte {
 	size := 4
 	b := 0