Add documentation to types and fields

Fixes #3.
2021-04-21 18:07:36 -07:00
parent 32fea7fae4
commit 748f2cf072
26 changed files with 387 additions and 28 deletions
@@ -7,12 +7,24 @@ import (
 	"github.com/me/mypkg"
 )

+// QueryWithAliasResponse is returned by QueryWithAlias on success.
 type QueryWithAliasResponse struct {
+	// user looks up a user by some stuff.
+	//
+	// See UserQueryInput for what stuff is supported.
+	// If query is null, returns the current user.
 	User QueryWithAliasUser `json:"User"`
 }

+// A User is a user!
 type QueryWithAliasUser struct {
-	ID      mypkg.ID `json:"ID"`
+	// id is the user's ID.
+	//
+	// It is stable, unique, and opaque, like all good IDs.
+	ID mypkg.ID `json:"ID"`
+	// id is the user's ID.
+	//
+	// It is stable, unique, and opaque, like all good IDs.
 	OtherID mypkg.ID `json:"otherID"`
 }