mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-15 21:28:54 +00: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.
66 lines
1.7 KiB
Go
66 lines
1.7 KiB
Go
// Copyright 2015 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 hugolib
|
|
|
|
import (
|
|
"github.com/gohugoio/hugo/source"
|
|
)
|
|
|
|
// Handler is used for processing files of a specific type.
|
|
type Handler interface {
|
|
FileConvert(*source.File, *Site) HandledResult
|
|
PageConvert(*Page) HandledResult
|
|
Read(*source.File, *Site) HandledResult
|
|
Extensions() []string
|
|
}
|
|
|
|
// Handle identifies functionality assosiated with certain file extentions.
|
|
type Handle struct {
|
|
extensions []string
|
|
}
|
|
|
|
// Extensions returns a list of extentions.
|
|
func (h Handle) Extensions() []string {
|
|
return h.extensions
|
|
}
|
|
|
|
// HandledResult describes the results of a file handling operation.
|
|
type HandledResult struct {
|
|
page *Page
|
|
file *source.File
|
|
err error
|
|
}
|
|
|
|
// HandledResult is an error
|
|
func (h HandledResult) Error() string {
|
|
if h.err != nil {
|
|
if h.page != nil {
|
|
return "Error: " + h.err.Error() + " for " + h.page.File.LogicalName()
|
|
}
|
|
if h.file != nil {
|
|
return "Error: " + h.err.Error() + " for " + h.file.LogicalName()
|
|
}
|
|
}
|
|
return h.err.Error()
|
|
}
|
|
|
|
func (h HandledResult) String() string {
|
|
return h.Error()
|
|
}
|
|
|
|
// Page returns the affected page.
|
|
func (h HandledResult) Page() *Page {
|
|
return h.page
|
|
}
|