Fix godoc comments.

This commit is contained in:
Martin Smith 2025-02-28 19:24:31 +00:00
parent de9a040d27
commit 67f91be8d0
5 changed files with 6 additions and 6 deletions

View File

@ -116,7 +116,7 @@ func (p *jsonLsPrinter) Snapshot(sn *restic.Snapshot) error {
})
}
// Print node in our custom JSON format, followed by a newline.
// Node formats node in our custom JSON format, followed by a newline.
func (p *jsonLsPrinter) Node(path string, node *restic.Node, isPrefixDirectory bool) error {
if isPrefixDirectory {
return nil
@ -175,7 +175,7 @@ type ncduLsPrinter struct {
depth int
}
// lsSnapshotNcdu prints a restic snapshot in Ncdu save format.
// Snapshot prints a restic snapshot in Ncdu save format.
// It opens the JSON list. Nodes are added with lsNodeNcdu and the list is closed by lsCloseNcdu.
// Format documentation: https://dev.yorhel.nl/ncdu/jsonfmt
func (p *ncduLsPrinter) Snapshot(sn *restic.Snapshot) error {

View File

@ -20,7 +20,7 @@ type Limiter interface {
// for downloads.
Downstream(r io.Reader) io.Reader
// Downstream returns a rate limited reader that is intended to be used
// DownstreamWriter returns a rate limited reader that is intended to be used
// for downloads.
DownstreamWriter(r io.Writer) io.Writer

View File

@ -19,6 +19,6 @@ type Migration interface {
// Name returns a short name.
Name() string
// Descr returns a description what the migration does.
// Desc returns a description what the migration does.
Desc() string
}

View File

@ -18,7 +18,7 @@ type WindowsAttributes struct {
SecurityDescriptor *[]byte `generic:"security_descriptor"`
}
// windowsAttrsToGenericAttributes converts the WindowsAttributes to a generic attributes map using reflection
// WindowsAttrsToGenericAttributes converts the WindowsAttributes to a generic attributes map using reflection
func WindowsAttrsToGenericAttributes(windowsAttributes WindowsAttributes) (attrs map[GenericAttributeType]json.RawMessage, err error) {
// Get the value of the WindowsAttributes
windowsAttributesValue := reflect.ValueOf(windowsAttributes)

View File

@ -79,9 +79,9 @@ const (
ConfigFile FileType = backend.ConfigFile
)
// WriteableFileType defines the different data types that can be modified via SaveUnpacked or RemoveUnpacked.
type WriteableFileType backend.FileType
// These are the different data types that can be modified via SaveUnpacked or RemoveUnpacked.
const (
WriteableSnapshotFile WriteableFileType = WriteableFileType(SnapshotFile)
)