From 549a4277b0c000d7cf0b2867c895599d283d70a1 Mon Sep 17 00:00:00 2001
From: Frédéric Guillot <fred@miniflux.net>
Date: Tue, 21 Nov 2017 15:46:59 -0800
Subject: Add flush history feature

---
 model/entry.go | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'model/entry.go')

diff --git a/model/entry.go b/model/entry.go
index 6858935..1053130 100644
--- a/model/entry.go
+++ b/model/entry.go
@@ -9,6 +9,7 @@ import (
 	"time"
 )
 
+// Entry statuses
 const (
 	EntryStatusUnread       = "unread"
 	EntryStatusRead         = "read"
@@ -17,6 +18,7 @@ const (
 	DefaultSortingDirection = "desc"
 )
 
+// Entry represents a feed item in the system.
 type Entry struct {
 	ID         int64         `json:"id"`
 	UserID     int64         `json:"user_id"`
@@ -33,8 +35,10 @@ type Entry struct {
 	Category   *Category     `json:"category,omitempty"`
 }
 
+// Entries represents a list of entries.
 type Entries []*Entry
 
+// ValidateEntryStatus makes sure the entry status is valid.
 func ValidateEntryStatus(status string) error {
 	switch status {
 	case EntryStatusRead, EntryStatusUnread, EntryStatusRemoved:
@@ -44,6 +48,7 @@ func ValidateEntryStatus(status string) error {
 	return fmt.Errorf(`Invalid entry status, valid status values are: "%s", "%s" and "%s"`, EntryStatusRead, EntryStatusUnread, EntryStatusRemoved)
 }
 
+// ValidateEntryOrder makes sure the sorting order is valid.
 func ValidateEntryOrder(order string) error {
 	switch order {
 	case "id", "status", "published_at", "category_title", "category_id":
@@ -53,6 +58,7 @@ func ValidateEntryOrder(order string) error {
 	return fmt.Errorf(`Invalid entry order, valid order values are: "id", "status", "published_at", "category_title", "category_id"`)
 }
 
+// ValidateDirection makes sure the sorting direction is valid.
 func ValidateDirection(direction string) error {
 	switch direction {
 	case "asc", "desc":
@@ -62,6 +68,7 @@ func ValidateDirection(direction string) error {
 	return fmt.Errorf(`Invalid direction, valid direction values are: "asc" or "desc"`)
 }
 
+// GetOppositeDirection returns the opposite sorting direction.
 func GetOppositeDirection(direction string) string {
 	if direction == "asc" {
 		return "desc"
-- 
cgit v1.2.3