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

@@ -11,7 +11,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
// Package asciidoc_config holds asciidoc related configuration.
// Package asciidocext_config holds asciidoc related configuration.
package asciidocext_config
var (

View File

@@ -121,7 +121,7 @@ type HeadingContext interface {
// HeadingRenderer describes a uniquely identifiable rendering hook.
type HeadingRenderer interface {
// Render writes the rendered content to w using the data in w.
// RenderHeading writes the rendered content to w using the data in w.
RenderHeading(cctx context.Context, w io.Writer, ctx HeadingContext) error
identity.Provider
}

View File

@@ -6,7 +6,7 @@ import (
"github.com/yuin/goldmark/text"
)
// Kind is the kind of an Hugo code block.
// KindCodeBlock is the kind of an Hugo code block.
var KindCodeBlock = ast.NewNodeKind("HugoCodeBlock")
// Its raw contents are the plain text of the code block.

View File

@@ -20,7 +20,7 @@ const (
AutoHeadingIDTypeBlackfriday = "blackfriday"
)
// DefaultConfig holds the default Goldmark configuration.
// Default holds the default Goldmark configuration.
var Default = Config{
Extensions: Extensions{
Typographer: Typographer{

View File

@@ -148,7 +148,7 @@ func (h chromaHighlighter) IsDefaultCodeBlockRenderer() bool {
var id = identity.NewPathIdentity("chroma", "highlight")
// GetIdentify is for internal use.
// GetIdentity is for internal use.
func (h chromaHighlighter) GetIdentity() identity.Identity {
return id
}

View File

@@ -199,7 +199,7 @@ func RenderASTAttributes(w hugio.FlexiWriter, attributes ...ast.Attribute) {
}
}
// Render writes the attributes to the given as attributes to an HTML element.
// RenderAttributes Render writes the attributes to the given as attributes to an HTML element.
// This is used for the default codeblock rendering.
// This performs HTML escaping of string attributes.
func RenderAttributes(w hugio.FlexiWriter, skipClass bool, attributes ...Attribute) {

View File

@@ -31,7 +31,7 @@ type Builder struct {
toc *Fragments
}
// Add adds the heading to the ToC.
// AddAt adds the heading to the ToC.
func (b *Builder) AddAt(h *Heading, row, level int) {
if b.toc == nil {
b.toc = &Fragments{}