Some godoc adjustments

4 files changed, 25 insertions, 5 deletions

diff --git a/resources/page/page.go b/resources/page/page.go
index 3c58dbb66..5ddacc8a6 100644
--- a/resources/page/page.go
+++ b/resources/page/page.go
@@ -78,13 +78,30 @@ type ChildCareProvider interface {
 // ContentProvider provides the content related values for a Page.
 type ContentProvider interface {
 	Content() (any, error)
+
+	// Plain returns the Page Content stripped of HTML markup.
 	Plain() string
+
+	// PlainWords returns a string slice from splitting Plain using https://pkg.go.dev/strings#Fields.
 	PlainWords() []string
+
+	// Summary returns a generated summary of the content.
+	// The breakpoint can be set manually by inserting a summary separator in the source file.
 	Summary() template.HTML
+
+	// Truncated returns whether the Summary  is truncated or not.
 	Truncated() bool
+
+	// FuzzyWordCount returns the approximate number of words in the content.
 	FuzzyWordCount() int
+
+	// WordCount returns the number of words in the content.
 	WordCount() int
+
+	// ReadingTime returns the reading time based on the length of plain text.
 	ReadingTime() int
+
+	// Len returns the length of the content.
 	Len() int
 }
 
diff --git a/resources/page/pages.go b/resources/page/pages.go
index e0f133500..4db6a4f68 100644
--- a/resources/page/pages.go
+++ b/resources/page/pages.go
@@ -22,11 +22,6 @@ import (
 	"github.com/gohugoio/hugo/resources/resource"
 )
 
-var (
-	_ resource.ResourcesConverter = Pages{}
-	_ compare.ProbablyEqer        = Pages{}
-)
-
 // Pages is a slice of pages. This is the most common list type in Hugo.
 type Pages []Page
 
@@ -149,3 +144,8 @@ func (ps Pages) removeFirstIfFound(p Page) Pages {
 // PagesFactory somehow creates some Pages.
 // We do a lot of lazy Pages initialization in Hugo, so we need a type.
 type PagesFactory func() Pages
+
+var (
+	_ resource.ResourcesConverter = Pages{}
+	_ compare.ProbablyEqer        = Pages{}
+)
diff --git a/resources/resource/resources.go b/resources/resource/resources.go
index 428decf84..a888d6fb4 100644
--- a/resources/resource/resources.go
+++ b/resources/resource/resources.go
@@ -30,6 +30,7 @@ type Resources []Resource
 // var _ resource.ResourceFinder = (*Namespace)(nil)
 // ResourcesConverter converts a given slice of Resource objects to Resources.
 type ResourcesConverter interface {
+	// For internal use.
 	ToResources() Resources
 }
 
diff --git a/resources/resource/resourcetypes.go b/resources/resource/resourcetypes.go
index ae076ed9a..a4f820188 100644
--- a/resources/resource/resourcetypes.go
+++ b/resources/resource/resourcetypes.go
@@ -155,7 +155,9 @@ type ResourceDataProvider interface {
 // different language.
 type ResourcesLanguageMerger interface {
 	MergeByLanguage(other Resources) Resources
+
 	// Needed for integration with the tpl package.
+	// For internal use.
 	MergeByLanguageInterface(other any) (any, error)
 }