]> git.maquefel.me Git - brevno-suite/hugo/commitdiff
resources/page: Mark some more interface methods as internal
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Wed, 20 Apr 2022 15:11:27 +0000 (17:11 +0200)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Sat, 23 Apr 2022 20:22:50 +0000 (22:22 +0200)
For the new documenttion.

resources/page/page.go

index 007a2f95426e3918c4fee045e065462b180f6133..3c58dbb665a6f56944415232d471aa1b4a6ac839 100644 (file)
@@ -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)
 }