boilerplate code and documentation

webring/webring.go

@@ -5,7 +5,6 @@ import (
 	"time"
 
 	"github.com/google/uuid"
-	"modernc.org/sqlite"
 )
 
 type SiteId string
@@ -55,49 +54,58 @@ type Webring struct {
     length int
 }
 
-func NewWebring(db *sql.DB) *Webring {
-    webring := Webring{Db: db}
-
-    return &webring
+// Retrieve the first website added to the webring
+func (webring *Webring) retrieveFirstSite() (*SiteEntry, error) {
+    return nil, nil
 }
 
-func (webring *Webring) retrieveFirstSite() (SiteEntry, error) {
-
-}
-
-func (webring *Webring) retrieveLastSite() (SiteEntry, error) {
-
+// Retrieve the latest website added to the webring
+func (webring *Webring) retrieveLastSite() (*SiteEntry, error) {
+    return nil, nil
 }
 
+// Commit a SiteEntry to the database
 func (webring *Webring) CreateSiteEntry(entry *SiteEntry) error {
-    // commit to database
+    return nil
 }
 
+// Retrieve a SiteEntry from the database by id
 func (webring *Webring) RetrieveSiteEntry(id SiteId) (*SiteEntry, error) {
-
+    return nil, nil
 }
 
+// Retrieve a SiteEntry from the database by url
+func (webring *Webring) RetriveSiteEntryByUrl(url string) (*SiteEntry, error) {
+    return nil, nil
+}
+
+// Update existing SiteEntry with the values of passed entry
 func (webring *Webring) UpdateSiteEntry(entry *SiteEntry) error {
-    // update existing SiteEntry
+    return nil
 }
 
+// Delete SiteEntry from database
 func (webring *Webring) DeleteSiteEntry(entry *SiteEntry) error {
-    // delete SiteEntry
+    return nil
 }
 
+// Commit a SiteWebmaster to the database
 func (webring *Webring) CreateSiteWebmaster(webmaster *SiteWebmaster) error {
-
+    return nil
 }
 
+// Retrieve a SiteWebmaster from the database by id
 func (webring *Webring) RetrieveSiteWebmaster(id WebmasterId) (*SiteWebmaster, error) {
-
+    return nil, nil
 }
 
+// Update a SiteWebmaster in the database with the values of the passed webmaster
 func (webring *Webring) UpdateSiteWebmaster(webmaster *SiteWebmaster) error {
-
+    return nil
 }
 
+// Delete a SiteWebmaster from the database
 func (webring *Webring) DeleteSiteWebmaster(webmaster *SiteWebmaster) error {
-
+    return nil
 }