Fix Godoc (#4080)

Author: bufdev

.godoclint.yaml

@@ -58,7 +58,7 @@ enable:
   #- require-pkg-doc
   - specific-file-pkg-doc
   - start-with-name
-  #- require-doc
+  - require-doc
   - deprecated
   #- max-len
   - no-unused-link

make/go/dep_godoclint.mk

@@ -12,7 +12,7 @@ $(call _assert_var,BUF_VERSION)
 #
 # Based off of dev branch.
 # https://github.com/bufbuild/godoc-lint/commits/dev
-GODOCLINT_VERSION ?= 5405ef06cd81f5b3115c6e52744f6cd9a8fa84f1a
+GODOCLINT_VERSION ?= 26c7b506fc2bf37a67fc2b42a3d9825c7ade2068
 
 GODOCLINT := $(CACHE_VERSIONS)/godoclint/$(GODOCLINT_VERSION)
 $(GODOCLINT):

private/buf/bufcli/flags_args.go

@@ -30,6 +30,9 @@ import (
 )
 
 const (
+	// DefaultArchiveStatus is the default archive status.
+	//
+	// This is currently unarchived.
 	DefaultArchiveStatus = unarchivedArchiveStatus
 
 	inputHashtagFlagName      = "__hashtag__"

private/buf/bufctl/controller.go

@@ -71,6 +71,7 @@ type ImageWithConfig interface {
 	isImageWithConfig()
 }
 
+// Controller is the central entrypoint for the Buf CLI.
 type Controller interface {
 	GetWorkspace(
 		ctx context.Context,
@@ -156,6 +157,7 @@ type Controller interface {
 	) (bufcheck.Client, error)
 }
 
+// NewController returns a new Controller.
 func NewController(
 	logger *slog.Logger,
 	container app.EnvStdioContainer,

private/buf/bufctl/option.go

@@ -18,26 +18,31 @@ import (
 	"github.com/bufbuild/buf/private/buf/buffetch"
 )
 
+// ControllerOption is a controller option.
 type ControllerOption func(*controller)
 
+// WithDisableSymlinks returns a new ControllerOption that
 func WithDisableSymlinks(disableSymlinks bool) ControllerOption {
 	return func(controller *controller) {
 		controller.disableSymlinks = disableSymlinks
 	}
 }
 
+// WithFileAnnotationErrorFormat returns a new ControllerOption that sets the FileAnnotation format.
 func WithFileAnnotationErrorFormat(fileAnnotationErrorFormat string) ControllerOption {
 	return func(controller *controller) {
 		controller.fileAnnotationErrorFormat = fileAnnotationErrorFormat
 	}
 }
 
+// WithFileAnnotationsToStdout returns a new ControllerOption that sends FileAnnotations to stdout
 func WithFileAnnotationsToStdout() ControllerOption {
 	return func(controller *controller) {
 		controller.fileAnnotationsToStdout = true
 	}
 }
 
+// WithCopyToInMemory returns a new ControllerOption that copies to memory.
 func WithCopyToInMemory() ControllerOption {
 	return func(controller *controller) {
 		controller.copyToInMemory = true
@@ -49,37 +54,43 @@ func WithCopyToInMemory() ControllerOption {
 // TODO FUTURE: split up to per-function.
 type FunctionOption func(*functionOptions)
 
+// WithTargetPaths returns a new FunctionOption that  sets the target paths.
 func WithTargetPaths(targetPaths []string, targetExcludePaths []string) FunctionOption {
 	return func(functionOptions *functionOptions) {
 		functionOptions.targetPaths = targetPaths
 		functionOptions.targetExcludePaths = targetExcludePaths
 	}
 }
 
+// WithImageExcludeSourceInfo returns a new FunctionOption that excludes source code info.
 func WithImageExcludeSourceInfo(imageExcludeSourceInfo bool) FunctionOption {
 	return func(functionOptions *functionOptions) {
 		functionOptions.imageExcludeSourceInfo = imageExcludeSourceInfo
 	}
 }
 
+// WithImageExcludeImports returns a new FunctionOption that excludes imports.
 func WithImageExcludeImports(imageExcludeImports bool) FunctionOption {
 	return func(functionOptions *functionOptions) {
 		functionOptions.imageExcludeImports = imageExcludeImports
 	}
 }
 
+// WithImageIncludeTypes returns a new FunctionOption that includes the given types.
 func WithImageIncludeTypes(imageTypes []string) FunctionOption {
 	return func(functionOptions *functionOptions) {
 		functionOptions.imageIncludeTypes = imageTypes
 	}
 }
 
+// WithImageExcludeTypes returns a new FunctionOption that excludes the given types.
 func WithImageExcludeTypes(imageExcludeTypes []string) FunctionOption {
 	return func(functionOptions *functionOptions) {
 		functionOptions.imageExcludeTypes = imageExcludeTypes
 	}
 }
 
+// WithImageAsFileDescriptorSet returns a new FunctionOption that returns the image as a FileDescriptorSet.
 func WithImageAsFileDescriptorSet(imageAsFileDescriptorSet bool) FunctionOption {
 	return func(functionOptions *functionOptions) {
 		functionOptions.imageAsFileDescriptorSet = imageAsFileDescriptorSet

private/buf/buffetch/internal/internal.go

@@ -878,6 +878,7 @@ func WithGetReadWriteBucketTargetPaths(targetPaths []string) GetReadWriteBucketO
 	}
 }
 
+// WithGetReadWriteBucketTargetExcludePaths sets the target exclude paths.
 func WithGetReadWriteBucketTargetExcludePaths(targetExcludePaths []string) GetReadWriteBucketOption {
 	return func(getReadWriteBucketOptions *getReadWriteBucketOptions) {
 		getReadWriteBucketOptions.targetExcludePaths = targetExcludePaths

private/bufpkg/bufanalysis/bufanalysistesting/bufanalysistesting.go

@@ -82,6 +82,7 @@ func NewFileAnnotation(
 	)
 }
 
+// FileAnnotationOption is an option for a FileAnnotation.
 type FileAnnotationOption func(*fileAnnotationOptions)
 
 // WithPluginName returns a FileAnnotationOption that sets the plugin name.

private/bufpkg/bufimage/bufimagemodify/internal/internal.go

@@ -28,6 +28,7 @@ type MarkSweeper interface {
 	Sweep() error
 }
 
+// NewMarkSweeper returns a new MarkSweeper.
 func NewMarkSweeper(image bufimage.Image) MarkSweeper {
 	return newMarkSweeper(image)
 }

private/bufpkg/bufmodule/file_type.go

@@ -23,8 +23,11 @@ import (
 )
 
 const (
+	// FileTypeProto is the file type for .proto files.
 	FileTypeProto FileType = iota + 1
+	// FileTypeDoc is the file type for documentation files.
 	FileTypeDoc
+	// FileTypeLicense is the file type for license files.
 	FileTypeLicense
 )
 
@@ -41,8 +44,10 @@ var (
 	}
 )
 
+// FileType is a tile type within a module.
 type FileType int
 
+// String implements fmt.Stringer.
 func (c FileType) String() string {
 	s, ok := fileTypeToString[c]
 	if !ok {

private/bufpkg/bufmodule/object_data.go

@@ -37,6 +37,7 @@ type ObjectData interface {
 	Data() []byte
 }
 
+// NewObjectData returns a new ObjectData.
 func NewObjectData(name string, data []byte) (ObjectData, error) {
 	return newObjectData(name, data)
 }