99ed59c1f832 — Sean Russell 11 years ago
Doc tweaks
2 files changed, 28 insertions(+), 31 deletions(-)

M generator.go
M patch.go
M generator.go +24 -26
@@ 15,16 15,15 @@ import (
 	"sync"
 )
 
-/* Generates library functions for interacting with a RESTful interface from a
- * JSON Swagger specification file.
- * 
- * Arguments:
- *   pack: the package name to use for the generated code
- *   j: JSON Swagger API specification (string)
- *   out: generated code are written line-by-line to this channel
- * Returns:
- *   error: in case of a spec parse error
- */
+// Generates library functions for interacting with a RESTful interface from a
+// JSON Swagger specification file.
+// 
+// Arguments:
+//   pack: the package name to use for the generated code
+//   j: JSON Swagger API specification (string)
+//   out: generated code are written line-by-line to this channel
+// Returns:
+//   error: in case of a spec parse error
 func GenerateApi(pack string, j []byte, out chan string) error {
 	t, e := ParseApi(j)
 	if e != nil {

          
@@ 40,22 39,21 @@ func GenerateApi(pack string, j []byte, 
 	return nil
 }
 
-/* Generates a library for a RESTful application interface from a Swagger
- * Resource Listing specification provided as a JSON byte array.
- * 
- * This function will recursively fetch the API definitions for the resources
- * listed in the Resource Listing from baseUri, and will produce a single file
- * containing all of the structures and functions for accessing those
- * resources.
- * 
- * Arguments:
- *   baseUri: The URL from whence the resource API specs can be pulled
- *   pack: the package name to use for the generated code
- *   j: JSON Swagger resource listing specification (string)
- *   out: generated code are written line-by-line to this channel
- * Returns:
- *   error: in case of a spec parse error
- */
+// Generates a library for a RESTful application interface from a Swagger
+// Resource Listing specification provided as a JSON byte array.
+// 
+// This function will recursively fetch the API definitions for the resources
+// listed in the Resource Listing from baseUri, and will produce a single file
+// containing all of the structures and functions for accessing those
+// resources.
+// 
+// Arguments:
+//   baseUri: The URL from whence the resource API specs can be pulled
+//   pack: the package name to use for the generated code
+//   j: JSON Swagger resource listing specification (string)
+//   out: generated code are written line-by-line to this channel
+// Returns:
+//   error: in case of a spec parse error
 func GenerateResourceListing(baseUri, pack string, j []byte, out chan string) error {
 	r, e := ParseResource(j)
 	if e != nil {

          
M patch.go +4 -5
@@ 4,11 4,10 @@ 
 
 package sashay
 
-/* Code generator functions for PATCH requests 
- * *Note* that this does not implement http://tools.ietf.org/html/rfc5789 or
- * (especially) any of http://tools.ietf.org/html/draft-pbryan-json-patch-04.
- * But that's OK, because neither does go-restful.
- */
+// Code generator functions for PATCH requests 
+// *Note* that this does not implement http://tools.ietf.org/html/rfc5789 or
+// (especially) any of http://tools.ietf.org/html/draft-pbryan-json-patch-04.
+// But that's OK, because neither does go-restful.
 func genPatch(api Api, op Operation, out chan string) {
 	genPostBase(api, op, out)
 }