From fc30e4b27f401aef01ef20dbf39daf21c7acc324 Mon Sep 17 00:00:00 2001 From: Alexey Skobkin Date: Tue, 29 Mar 2016 10:50:49 +0300 Subject: [PATCH] More humble doc comments. --- meta_post.go | 1 + page.go | 1 + post.go | 1 + token.go | 1 + user.go | 1 + 5 files changed, 5 insertions(+) diff --git a/meta_post.go b/meta_post.go index 9dd5d8e..b0abbf6 100644 --- a/meta_post.go +++ b/meta_post.go @@ -1,5 +1,6 @@ package point +// MetaPost represents the meta-post object in API response. It contains the post object and some user dependent data type MetaPost struct { Bookmarked bool `json:"bookmarked"` Uid int `json:"uid"` diff --git a/page.go b/page.go index 3e304b4..fdcf1be 100644 --- a/page.go +++ b/page.go @@ -1,5 +1,6 @@ package point +// Page represents the basic feed API response which contains array of posts and has_next flag type Page struct { HasNext bool `json:"has_next"` Posts []MetaPost `json:"posts"` diff --git a/post.go b/post.go index bf48553..c1941de 100644 --- a/post.go +++ b/post.go @@ -1,5 +1,6 @@ package point +// Post represents the basic post data type Post struct { Id string `json:"id"` Author User `json:"author"` diff --git a/token.go b/token.go index 26fb9a9..c52d7f0 100644 --- a/token.go +++ b/token.go @@ -1,5 +1,6 @@ package point +// Token represents the login API method response and contains important login data type Token struct { AuthToken string `json:"token"` CsRfToken string `json:"csrf_token"` diff --git a/user.go b/user.go index ee5a5b3..475bfaa 100644 --- a/user.go +++ b/user.go @@ -1,5 +1,6 @@ package point +// User represents the user object in API response type User struct { Id int `json:"id"` Login string `json:"login"`