From 6e682828ee4cbc13859ffc144162d48f16ccc87f Mon Sep 17 00:00:00 2001 From: Alexey Skobkin Date: Tue, 29 Mar 2016 10:41:00 +0300 Subject: [PATCH] Humble doc comments. --- client.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/client.go b/client.go index 54a1230..1d02908 100644 --- a/client.go +++ b/client.go @@ -1,8 +1,9 @@ +// Package point_tools implements simple Point Tools API wrapper for sending some service requests. package point_tools import ( - "bitbucket.org/skobkin/point-api-go" "bitbucket.org/skobkin/dumb-http-go" + "bitbucket.org/skobkin/point-api-go" "encoding/json" "log" "net/http" @@ -15,6 +16,7 @@ type PointToolsClient struct { token string } +// New creates new Point Tools API client instance and initialize it to use provided URL and token func New(apiUrl, token string) PointToolsClient { return PointToolsClient{ simple_http.Client{http.Client{}}, @@ -34,6 +36,7 @@ func GetPageJSON(page point.Page) (string, error) { return string(b[:]), nil } +// SendPage sends page to Point Tools crawler API gate for processing func (c *PointToolsClient) SendPage(page point.Page) (ReceiveAllPageResponse, error) { var response ReceiveAllPageResponse