mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
81c13171a9
As pointed out by the linter, some exported functions and types are missing doc comments. The linter warnings have been reduced from 194 to 116. Not all missing comments have been added in this commit though.
37 lines
1.3 KiB
Go
37 lines
1.3 KiB
Go
// Copyright 2017-present The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// Package docshelper provides some helpers for the Hugo documentation, and
|
|
// is of limited interest for the general Hugo user.
|
|
package docshelper
|
|
|
|
import (
|
|
"encoding/json"
|
|
)
|
|
|
|
// DocProviders contains all DocProviders added to the system.
|
|
var DocProviders = make(map[string]DocProvider)
|
|
|
|
// AddDocProvider adds or updates the DocProvider for a given name.
|
|
func AddDocProvider(name string, provider DocProvider) {
|
|
DocProviders[name] = provider
|
|
}
|
|
|
|
// DocProvider is used to save arbitrary JSON data
|
|
// used for the generation of the documentation.
|
|
type DocProvider func() map[string]interface{}
|
|
|
|
// MarshalJSON returns a JSON representation of the DocProvider.
|
|
func (d DocProvider) MarshalJSON() ([]byte, error) {
|
|
return json.MarshalIndent(d(), "", " ")
|
|
}
|