Merge pull request #8 from brunomvsouza/documentation

Add licence on files and package descriptions

api/account/entity.go

@@ -1,3 +1,8 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
+// Package account implements account entities and services
 package account // import "go.bmvs.io/ynab/api/account"
 
 // Account represents an account for a budget

api/account/enum.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package account
 
 // Type identifies an account type

api/account/example_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package account_test
 
 import (

api/account/service.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package account
 
 import (

api/budget/entity.go

@@ -1,3 +1,8 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
+// Package budget implements budget entities and services
 package budget // import "go.bmvs.io/ynab/api/budget"
 
 import (

api/budget/example_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package budget_test
 
 import (

api/budget/service.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package budget
 
 import (

api/budget/service_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package budget_test
 
 import (

api/category/entity.go

@@ -1,3 +1,8 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
+// Package category implements category entities and services
 package category // import "go.bmvs.io/ynab/api/category"
 import "go.bmvs.io/ynab/api"
 

api/category/enum.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package category
 
 // Goal represents the goal of a category

api/category/example_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package category_test
 
 import (

api/category/service.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package category
 
 import (

api/category/service_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package category_test
 
 import (

api/client.go

@@ -1,3 +1,9 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
+// Package api implements shared structures and behaviours of
+// the API services
 package api // import "go.bmvs.io/ynab/api"
 
 // ClientReader contract for a read only client

api/date.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package api
 
 import (

api/date_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package api_test
 
 import (

api/error.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package api
 
 import (

api/example_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package api_test
 
 import (

api/month/entity.go

@@ -1,3 +1,8 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
+// Package month implements month entities and services
 package month // import "go.bmvs.io/ynab/api/month"
 
 import (

api/month/example_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package month_test
 
 import (

api/month/service.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package month
 
 import (

api/month/service_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package month_test
 
 import (

api/payee/entity.go

@@ -1,3 +1,8 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
+// Package payee implements payee entities and services
 package payee // import "go.bmvs.io/ynab/api/payee"
 
 // Payee represents a payee for a budget

api/payee/example_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package payee_test
 
 import (

api/payee/service.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package payee
 
 import (

api/payee/service_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package payee_test
 
 import (

api/ratelimit.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package api
 
 import (

api/ratelimit_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package api
 
 import (

api/transaction/entity.go

@@ -1,3 +1,8 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
+// Package transaction implements transaction entities and services
 package transaction // import "go.bmvs.io/ynab/api/transaction"
 
 import "go.bmvs.io/ynab/api"

api/transaction/enum.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package transaction
 
 // Status represents the type of a transaction

api/transaction/example_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package transaction_test
 
 import (

api/transaction/payload.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package transaction
 
 import (

api/transaction/service.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package transaction
 
 import (

api/transaction/service_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package transaction_test
 
 import (

api/user/entity.go

@@ -1,3 +1,8 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
+// Package user implements transaction user and services
 package user // import "go.bmvs.io/ynab/api/user"
 
 // User represents an user

api/user/example_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package user_test
 
 import (

api/user/service.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package user
 
 import (

api/user/service_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package user_test
 
 import (

client.go

@@ -1,3 +1,8 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
+// Package ynab implements the client API
 package ynab // import "go.bmvs.io/ynab"
 
 import (

client_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package ynab
 
 import (

example_test.go

@@ -1,3 +1,7 @@
+// Copyright (c) 2018, Bruno M V Souza <[email protected]>. All rights reserved.
+// Use of this source code is governed by a BSD-2-Clause license that can be
+// found in the LICENSE file.
+
 package ynab_test
 
 import (