update docs

README.md

@@ -9,6 +9,10 @@ RTSP 1.0 primitives for the Go programming language.
 
 See [rtsp-simple-server](https://github.com/aler9/rtsp-simple-server) and [rtsp-simple-proxy](https://github.com/aler9/rtsp-simple-proxy) for examples on how to use this library.
 
+## Documentation
+
+https://godoc.org/github.com/aler9/gortsplib
+
 ## Links
 
 IETF Standard

auth-client.go

@@ -14,7 +14,8 @@ func md5Hex(in string) string {
 	return hex.EncodeToString(h.Sum(nil))
 }
 
-// AuthClient is an object that helps a client sending its credentials to a server.
+// AuthClient is an object that helps a client sending its credentials to a
+// server, with the Digest authentication method.
 type AuthClient struct {
 	user  string
 	pass  string

auth-server.go

@@ -7,7 +7,8 @@ import (
 	"net/url"
 )
 
-// AuthServer is an object that helps a server validating the credentials of a client.
+// AuthServer is an object that helps a server validating the credentials of
+// a client, sent with the Digest authentication method.
 type AuthServer struct {
 	nonce string
 	realm string

request.go

@@ -32,9 +32,16 @@ const (
 
 // Request is a RTSP request.
 type Request struct {
-	Method  Method
+	// request method
-	Url     *url.URL
+	Method Method
-	Header  Header
+
+	// request url
+	Url *url.URL
+
+	// map of header values
+	Header Header
+
+	// optional content
 	Content []byte
 }
 

response.go

@@ -61,10 +61,17 @@ const (
 
 // Response is a RTSP response.
 type Response struct {
-	StatusCode    StatusCode
+	// numeric status code
+	StatusCode StatusCode
+
+	// status message
 	StatusMessage string
-	Header        Header
+
-	Content       []byte
+	// map of header values
+	Header Header
+
+	// optional content
+	Content []byte
 }
 
 func readResponse(br *bufio.Reader) (*Response, error) {