Skip to content

docs: format doc comments to follow Go conventions in feed.go #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aoright wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: format doc comments to follow Go conventions in feed.go #119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions feed.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,28 @@ import (
"time"
)

// Link represents an RSS/Atom link element.
type Link struct {
Href, Rel, Type, Length string
}

// Author represents an author of a feed or item.
type Author struct {
Name, Email string
}

// Image represents an image or logo for a feed.
type Image struct {
Url, Title, Link string
Width, Height int
}

// Enclosure represents an enclosure element in an RSS/Atom item.
type Enclosure struct {
Url, Length, Type string
}

// Item represents a single feed item or story.
type Item struct {
Title string
Link *Link
Expand All @@ -39,6 +44,7 @@ type Item struct {
Content string
}

// Feed represents a syndication feed containing items and metadata.
type Feed struct {
Title string
Link *Link
Expand All @@ -53,12 +59,12 @@ type Feed struct {
Image *Image
}

// add a new Item to a Feed
// Add adds a new Item to a Feed.
func (f *Feed) Add(item *Item) {
f.Items = append(f.Items, item)
}

// returns the first non-zero time formatted as a string or ""
// anyTimeFormat returns the first non-zero time formatted as a string or "".
func anyTimeFormat(format string, times ...time.Time) string {
for _, t := range times {
if !t.IsZero() {
Expand All @@ -68,13 +74,13 @@ func anyTimeFormat(format string, times ...time.Time) string {
return ""
}

// interface used by ToXML to get a object suitable for exporting XML.
// XmlFeed is an interface used by ToXML to get an object suitable for exporting XML.
type XmlFeed interface {
FeedXml() interface{}
}

// turn a feed object (either a Feed, AtomFeed, or RssFeed) into xml
// returns an error if xml marshaling fails
// ToXML converts a feed object (either a Feed, AtomFeed, or RssFeed) into XML.
// It returns an error if XML marshaling fails.
func ToXML(feed XmlFeed) (string, error) {
x := feed.FeedXml()
data, err := xml.MarshalIndent(x, "", " ")
Expand Down
Loading