From 3e6b3544934cb71e3a3b0edf9bc184241ac1ad7f Mon Sep 17 00:00:00 2001 From: "Andrew Gallant (Ocelot)" Date: Fri, 11 May 2012 01:58:52 -0400 Subject: add a little more docs for errors --- nexgb/xgbgen/go_error.go | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'nexgb/xgbgen') diff --git a/nexgb/xgbgen/go_error.go b/nexgb/xgbgen/go_error.go index 81a017b..55fd28b 100644 --- a/nexgb/xgbgen/go_error.go +++ b/nexgb/xgbgen/go_error.go @@ -68,6 +68,8 @@ func (e *Error) ImplementsError(c *Context) { c.Putln("return err.Sequence") c.Putln("}") c.Putln("") + c.Putln("// BadId returns the 'BadValue' number if one exists for the "+ + "%s error. If no bad value exists, 0 is returned.", e.ErrConst()) c.Putln("func (err %s) BadId() uint32 {", e.ErrType()) if !c.protocol.isExt() { c.Putln("return err.BadValue") @@ -75,6 +77,8 @@ func (e *Error) ImplementsError(c *Context) { c.Putln("return 0") } c.Putln("}") + c.Putln("// Error returns a rudimentary string representation of the %s "+ + "error.", e.ErrConst()) c.Putln("") c.Putln("func (err %s) Error() string {", e.ErrType()) ErrorFieldString(c, e.Fields, e.ErrConst()) @@ -130,6 +134,8 @@ func (e *ErrorCopy) ImplementsError(c *Context) { c.Putln("return err.Sequence") c.Putln("}") c.Putln("") + c.Putln("// BadId returns the 'BadValue' number if one exists for the "+ + "%s error. If no bad value exists, 0 is returned.", e.ErrConst()) c.Putln("func (err %s) BadId() uint32 {", e.ErrType()) if !c.protocol.isExt() { c.Putln("return err.BadValue") @@ -138,6 +144,8 @@ func (e *ErrorCopy) ImplementsError(c *Context) { } c.Putln("}") c.Putln("") + c.Putln("// Error returns a rudimentary string representation of the %s "+ + "error.", e.ErrConst()) c.Putln("func (err %s) Error() string {", e.ErrType()) ErrorFieldString(c, e.Old.(*Error).Fields, e.ErrConst()) c.Putln("}") -- cgit v1.2.3