all: Fix comments for exported functions and packages

This commit is contained in:
Oleksandr Redko
2023-05-18 12:05:56 +03:00
committed by Bjørn Erik Pedersen
parent 24e7d0c174
commit 610cedaa61
24 changed files with 30 additions and 30 deletions

View File

@@ -334,7 +334,7 @@ type PageWithoutContent interface {
// Used in change/dependency tracking.
identity.Provider
// Headings returns the headings for this page when a filter is set.
// HeadingsFiltered returns the headings for this page when a filter is set.
// This is currently only triggered with the Related content feature
// and the "fragments" type of index.
HeadingsFiltered(context.Context) tableofcontents.Headings
@@ -373,7 +373,7 @@ type RefProvider interface {
// RelRef returns a relative URL to a page.
RelRef(argsm map[string]any) (string, error)
// RefFrom is for internal use only.
// RelRefFrom is for internal use only.
RelRefFrom(argsm map[string]any, source any) (string, error)
}

View File

@@ -128,13 +128,13 @@ type Site interface {
// For internal use only.
GetPageWithTemplateInfo(info tpl.Info, ref ...string) (Page, error)
// BuildDraft is deprecated and will be removed in a future release.
// BuildDrafts is deprecated and will be removed in a future release.
BuildDrafts() bool
// IsMultilingual reports whether this site is configured with more than one language.
// IsMultiLingual reports whether this site is configured with more than one language.
IsMultiLingual() bool
// LanguagePrefi returns the language prefix for this site.
// LanguagePrefix returns the language prefix for this site.
LanguagePrefix() string
}