vlog: Tweak things to fix bad formatting in godoc
Change-Id: Iefd44525f46cdbebd99da929639294685bd6180d
diff --git a/vlog/doc.go b/vlog/doc.go
index 6c1aa9d..685c0fc 100644
--- a/vlog/doc.go
+++ b/vlog/doc.go
@@ -6,23 +6,27 @@
// glog; the differences from glog are:
//
// - interfaces are used to allow for multiple implementations and instances.
-// In particular, application and runtime logging can be separated.
-// We also expect to stream log messages to external log collectors rather
-// to local storage.
+// In particular, application and runtime logging can be separated.
+// We also expect to stream log messages to external log collectors rather
+// to local storage.
+//
// - the Warn family of methods are not provided; their main use
-// is to avoid the flush that's implicit in the Error routines
-// rather than any semantic difference between warnings and errors.
+// is to avoid the flush that's implicit in the Error routines
+// rather than any semantic difference between warnings and errors.
+//
// - Info logging and Event logging is separated with the former expected
-// to be somewhat spammy and the latter to be used sparingly.
+// to be somewhat spammy and the latter to be used sparingly.
+//
// - Event logging includes methods for unconditionally (i.e. regardless
-// of any command line options) logging the current goroutine's stack
-// or the stacks of all goroutines.
+// of any command line options) logging the current goroutine's stack
+// or the stacks of all goroutines.
+//
// - The use of interfaces and encapsulated state means that a single
-// function (V) can no longer be used for 'if guarded' and 'chained' logging.
-// That is:
-// if vlog.V(1) { ... } and vlog.V(1).Infof( ... )
-// become
-// if logger.V(1) { ... } and logger.VI(1).Infof( ... )
+// function (V) can no longer be used for 'if guarded' and 'chained' logging.
+// That is:
+// if vlog.V(1) { ... } and vlog.V(1).Infof( ... )
+// becomes
+// if logger.V(1) { ... } and logger.VI(1).Infof( ... )
//
// vlog also creates a global instance of the Logger (vlog.Log) and
// provides command line flags (see flags.go). Parsing of these flags is
@@ -42,7 +46,7 @@
// Log files will be written to this directory instead of the
// default temporary directory.
//
-// Other flags provide aids to debugging.
+// Other flags provide aids to debugging:
//
// -log_backtrace_at=""
// When set to a file and line number holding a logging statement,
@@ -59,7 +63,7 @@
// "glob" pattern and N is a V level. For instance,
// -vmodule=gopher*=3
// sets the V level to 3 in all Go files whose names begin "gopher".
-// -max_stack_buf_size=<size in bytes>
+// -max_stack_buf_size=<size in bytes>
// Set the max size (bytes) of the byte buffer to use for stack
// traces. The default max is 4M; use powers of 2 since the
// stack size will be grown exponentially until it exceeds the max.
diff --git a/vlog/log.go b/vlog/log.go
index 92c9ba6..87595df 100644
--- a/vlog/log.go
+++ b/vlog/log.go
@@ -235,10 +235,10 @@
type discardInfo struct{}
-func (_ *discardInfo) Info(...interface{}) {}
-func (_ *discardInfo) Infof(_ string, _ ...interface{}) {}
-func (_ *discardInfo) InfoDepth(_ int, _ ...interface{}) {}
-func (_ *discardInfo) InfoStack(_ bool) {}
+func (*discardInfo) Info(...interface{}) {}
+func (*discardInfo) Infof(string, ...interface{}) {}
+func (*discardInfo) InfoDepth(int, ...interface{}) {}
+func (*discardInfo) InfoStack(bool) {}
func (l *Logger) VI(v int) interface {
// Info logs to the INFO log.
diff --git a/vlog/opts.go b/vlog/opts.go
index 4d7328b..49944f1 100644
--- a/vlog/opts.go
+++ b/vlog/opts.go
@@ -16,50 +16,50 @@
type MaxStackBufSize int
// If true, logs are written to standard error as well as to files.
-func (_ AlsoLogToStderr) LoggingOpt() {}
+func (AlsoLogToStderr) LoggingOpt() {}
// Enable V-leveled logging at the specified level.
-func (_ Level) LoggingOpt() {}
+func (Level) LoggingOpt() {}
// log files will be written to this directory instead of the
// default temporary directory.
-func (_ LogDir) LoggingOpt() {}
+func (LogDir) LoggingOpt() {}
// If true, logs are written to standard error instead of to files.
-func (_ LogToStderr) LoggingOpt() {}
+func (LogToStderr) LoggingOpt() {}
// Set the max size (bytes) of the byte buffer to use for stack
// traces. The default max is 4M; use powers of 2 since the
// stack size will be grown exponentially until it exceeds the max.
// A min of 128K is enforced and any attempts to reduce this will
// be silently ignored.
-func (_ MaxStackBufSize) LoggingOpt() {}
+func (MaxStackBufSize) LoggingOpt() {}
// The syntax of the argument is a comma-separated list of pattern=N,
// where pattern is a literal file name (minus the ".go" suffix) or
// "glob" pattern and N is a V level. For instance, gopher*=3
// sets the V level to 3 in all Go files whose names begin "gopher".
-func (_ ModuleSpec) LoggingOpt() {}
+func (ModuleSpec) LoggingOpt() {}
// The syntax of the argument is a comma-separated list of regexp=N,
// where pattern is a regular expression matched against the full path name
// of files and N is a V level. For instance, myco.com/web/.*=3
// sets the V level to 3 in all Go files whose path names match myco.com/web/.*".
-func (_ FilepathSpec) LoggingOpt() {}
+func (FilepathSpec) LoggingOpt() {}
// Log events at or above this severity are logged to standard
// error as well as to files.
-func (_ StderrThreshold) LoggingOpt() {}
+func (StderrThreshold) LoggingOpt() {}
// When set to a file and line number holding a logging statement, such as
// gopherflakes.go:234
// a stack trace will be written to the Info log whenever execution
// hits that statement. (Unlike with -vmodule, the ".go" must be
// present.)
-func (_ TraceLocation) LoggingOpt() {}
+func (TraceLocation) LoggingOpt() {}
// If true, enables automatic flushing of log output on every call
-func (_ AutoFlush) LoggingOpt() {}
+func (AutoFlush) LoggingOpt() {}
// If true, allows this call to ConfigureLogger to override a prior configuration.
-func (_ OverridePriorConfiguration) LoggingOpt() {}
+func (OverridePriorConfiguration) LoggingOpt() {}
