doc(pkg/gitreceive/storage/endpoint.go): add documentation for the endpoint struct

Aaron Schlesinger · Aaron Schlesinger · commit 773df6b31e8f · 2016-03-03T16:36:57.000-08:00
diff --git a/pkg/gitreceive/storage/endpoint.go b/pkg/gitreceive/storage/endpoint.go
@@ -33,8 +33,11 @@ func stripScheme(str string) string {
 	return str
 }
 
+// Endpoint represents all the details about a storage endpoint
 type Endpoint struct {
+	// URLStr is the url string, stripped of its scheme
 	URLStr string
+	// Secure determines if TLS should be used (e.g. a "https://" scheme)
 	Secure bool
 }
 

Original file line number	Diff line number	Diff line change
`@@ -33,8 +33,11 @@ func stripScheme(str string) string {`
`33`	`33`	`return str`
`34`	`34`	`}`
`35`	`35`
	`36`	`+// Endpoint represents all the details about a storage endpoint`
`36`	`37`	`type Endpoint struct {`
	`38`	`+ // URLStr is the url string, stripped of its scheme`
`37`	`39`	`URLStr string`
	`40`	`+ // Secure determines if TLS should be used (e.g. a "https://" scheme)`
`38`	`41`	`Secure bool`
`39`	`42`	`}`
`40`	`43`