hugo

commit 625be77e083bf992ce81295fb875a664c68bcef3
parent 097fd588ca2928056122991caaa879e835c5ba62
Author: Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Date:   Wed, 20 Apr 2022 17:11:27 +0200

resources/page: Mark some more interface methods as internal

For the new documenttion.

Diffstat:
M
resources/page/page.go
 | 
7
+++++++

1 file changed, 7 insertions(+), 0 deletions(-)
diff --git a/resources/page/page.go b/resources/page/page.go
@@ -184,6 +184,7 @@ type PageMetaProvider interface {
 	Path() string
 
 	// This is just a temporary bridge method. Use Path in templates.
+	// Pathc is for internal usage only.
 	Pathc() string
 
 	// The slug, typically defined in front matter.
@@ -306,14 +307,20 @@ type RawContentProvider interface {
 // RefProvider provides the methods needed to create reflinks to pages.
 type RefProvider interface {
 	Ref(argsm map[string]any) (string, error)
+
+	// RefFrom is for internal use only.
 	RefFrom(argsm map[string]any, source any) (string, error)
+
 	RelRef(argsm map[string]any) (string, error)
+
+	// RefFrom is for internal use only.
 	RelRefFrom(argsm map[string]any, source any) (string, error)
 }
 
 // RelatedKeywordsProvider allows a Page to be indexed.
 type RelatedKeywordsProvider interface {
 	// Make it indexable as a related.Document
+	// RelatedKeywords is meant for internal usage only.
 	RelatedKeywords(cfg related.IndexConfig) ([]related.Keyword, error)
 }