sdl: error: Fix documentation #265

malashin · malashin · commit 6cfd4a11c731 · 2017-11-03T19:40:40.000+10:00
diff --git a/sdl/error.go b/sdl/error.go
@@ -14,7 +14,7 @@ const (
 	LASTERROR             = C.SDL_LASTERROR   // the highest numbered predefined error
 )
 
-// ErrorCode is an SDL error code for common errors.
+// ErrorCode is an error code used in SDL error messages.
 type ErrorCode uint32
 type cErrorCode C.SDL_errorcode
 
@@ -41,7 +41,7 @@ func ClearError() {
 	C.SDL_ClearError()
 }
 
-// Error sets the SDL error message to the predefined string specified by code.
+// Error sets the SDL error message to the specified error code.
 func Error(code ErrorCode) {
 	C.SDL_Error(code.c())
 }

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ const (`
`14`	`14`	`LASTERROR = C.SDL_LASTERROR // the highest numbered predefined error`
`15`	`15`	`)`
`16`	`16`
`17`		`-// ErrorCode is an SDL error code for common errors.`
	`17`	`+// ErrorCode is an error code used in SDL error messages.`
`18`	`18`	`type ErrorCode uint32`
`19`	`19`	`type cErrorCode C.SDL_errorcode`
`20`	`20`
`@@ -41,7 +41,7 @@ func ClearError() {`
`41`	`41`	`C.SDL_ClearError()`
`42`	`42`	`}`
`43`	`43`
`44`		`-// Error sets the SDL error message to the predefined string specified by code.`
	`44`	`+// Error sets the SDL error message to the specified error code.`
`45`	`45`	`func Error(code ErrorCode) {`
`46`	`46`	`C.SDL_Error(code.c())`
`47`	`47`	`}`