multi: Fix godoc comment var/func names.

jholdstock · davecgh · commit 6402932f74cf · 2026-04-23T21:57:13.000-05:00
Ensure the godoc comment for all exported (and some private) funcs and
vars have the correct names.
diff --git a/blockchain/fullblocktests/error.go b/blockchain/fullblocktests/error.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2022 The Decred developers
+// Copyright (c) 2022-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -205,8 +205,8 @@ const (
 	// have a valid missed sstx input as per the stake ticket database.
 	ErrInvalidSSRtx = ErrorKind("ErrInvalidSSRtx")
 
-	// ErrInvalidRevNum indicates that the number of revocations from the header
-	// was not the same as the number of SSRtx included in the block.
+	// ErrRevocationsMismatch indicates that the number of revocations from the
+	// header was not the same as the number of SSRtx included in the block.
 	ErrRevocationsMismatch = ErrorKind("ErrRevocationsMismatch")
 
 	// ErrTicketCommitment indicates that a ticket commitment contains an amount
@@ -218,7 +218,7 @@ const (
 	// commitments.
 	ErrBadNumPayees = ErrorKind("ErrBadNumPayees")
 
-	// ErrBadPayeeScriptType indicates that either a vote or revocation
+	// ErrMismatchedPayeeHash indicates that either a vote or revocation
 	// transaction output that corresponds to a ticket commitment does not pay
 	// to the hash required by the commitment.
 	ErrMismatchedPayeeHash = ErrorKind("ErrMismatchedPayeeHash")
diff --git a/blockchain/stake/error.go b/blockchain/stake/error.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2014 Conformal Systems LLC.
-// Copyright (c) 2015-2021 The Decred developers
+// Copyright (c) 2015-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -23,15 +23,15 @@ const (
 	// ErrSStxNoOutputs indicates that a given SStx has no outputs.
 	ErrSStxNoOutputs = ErrorKind("ErrSStxNoOutputs")
 
-	// ErrSStxInvalidInput indicates that an invalid output has been used as
-	// an input for a SStx; only non-SStx tagged outputs may be used to
-	// purchase stake tickets.
+	// ErrSStxInvalidInputs indicates that an invalid output has been used as an
+	// input for a SStx; only non-SStx tagged outputs may be used to purchase
+	// stake tickets.
 	// TODO: Add this into validate
 	// Ensure that all inputs are not tagged SStx outputs of some sort,
 	// along with checks to make sure they exist and are available.
 	ErrSStxInvalidInputs = ErrorKind("ErrSStxInvalidInputs")
 
-	// ErrSStxInvalidOutput indicates that the output for an SStx tx is
+	// ErrSStxInvalidOutputs indicates that the output for an SStx tx is
 	// invalid; in particular, either the output was not tagged SStx or the
 	// OP_RETURNs were missing or contained invalid addresses.
 	ErrSStxInvalidOutputs = ErrorKind("ErrSStxInvalidOutputs")
@@ -79,8 +79,8 @@ const (
 	// included as the first output.
 	ErrSSGenNoReference = ErrorKind("ErrSSGenNoReference")
 
-	// ErrSSGenNoReference indicates that the OP_RETURN included as the
-	// first output was corrupted in some way.
+	// ErrSSGenBadReference indicates that the OP_RETURN included as the first
+	// output was corrupted in some way.
 	ErrSSGenBadReference = ErrorKind("ErrSSGenBadReference")
 
 	// ErrSSGenNoVotePush indicates that there is no vote bits OP_RETURN
diff --git a/blockchain/stake/internal/ticketdb/error.go b/blockchain/stake/internal/ticketdb/error.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2015-2021 The Decred developers
+// Copyright (c) 2015-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -15,8 +15,8 @@ const (
 	// was took small.
 	ErrUndoDataShortRead = ErrorKind("ErrUndoDataShortRead")
 
-	// ErrUndoDataNoEntries indicates that the data for undoing ticket data
-	// in a serialized entry was corrupt.
+	// ErrUndoDataCorrupt indicates that the data for undoing ticket data in a
+	// serialized entry was corrupt.
 	ErrUndoDataCorrupt = ErrorKind("ErrUndoDataCorrupt")
 
 	// ErrTicketHashesShortRead indicates that the given ticket hashes
diff --git a/config.go b/config.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2013-2016 The btcsuite developers
-// Copyright (c) 2015-2024 The Decred developers
+// Copyright (c) 2015-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -463,8 +463,9 @@ func newConfigParser(cfg *config, so *serviceOptions, options flags.Options) *fl
 	return parser
 }
 
-// createDefaultConfig copies the file sample-dcrd.conf to the given destination path,
-// and populates it with some randomly generated RPC username and password.
+// createDefaultConfigFile copies the file sample-dcrd.conf to the given
+// destination path, and populates it with some randomly generated RPC username
+// and password.
 func createDefaultConfigFile(destPath string, authType string) error {
 	// Create the destination directory if it does not exist.
 	err := os.MkdirAll(filepath.Dir(destPath), 0700)
diff --git a/crypto/rand/default.go b/crypto/rand/default.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2024 The Decred developers
+// Copyright (c) 2024-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -147,8 +147,7 @@ func ShuffleSlice[S ~[]E, E any](s S) {
 	})
 }
 
-// Int returns a uniform random value in [0,max).
-// Panics if max <= 0.
+// BigInt returns a uniform random value in [0,max). Panics if max <= 0.
 func BigInt(max *big.Int) *big.Int {
 	globalRand.Lock()
 	defer globalRand.Unlock()
diff --git a/crypto/rand/uniform.go b/crypto/rand/uniform.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2024 The Decred developers
+// Copyright (c) 2024-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 //
@@ -228,8 +228,7 @@ func (p *PRNG) Shuffle(n int, swap func(i, j int)) {
 	}
 }
 
-// Int returns a uniform random value in [0,max).
-// Panics if max <= 0.
+// BigInt returns a uniform random value in [0,max). Panics if max <= 0.
 func (p *PRNG) BigInt(max *big.Int) *big.Int {
 	// Will never error with our reader.
 	n, _ := rand.Int(p, max)
diff --git a/database/driver.go b/database/driver.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2015-2016 The btcsuite developers
-// Copyright (c) 2016-2020 The Decred developers
+// Copyright (c) 2016-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -32,7 +32,7 @@ type Driver struct {
 	UseLogger func(logger slog.Logger)
 }
 
-// driverList holds all of the registered database backends.
+// drivers holds all of the registered database backends.
 var drivers = make(map[string]*Driver)
 
 // RegisterDriver adds a backend database driver to available interfaces.
diff --git a/gcs/blockcf2/blockcf.go b/gcs/blockcf2/blockcf.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2019-2022 The Decred developers
+// Copyright (c) 2019-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -146,9 +146,9 @@ type commitmentConverter struct {
 	allScripts []byte
 }
 
-// commitmentToPaymentScript converts a commitment output script of a ticket
-// purchase to either a pay-to-pubkey-hash or a pay-to-script-hash script
-// according to the commitment.
+// paymentScript converts a commitment output script of a ticket purchase to
+// either a pay-to-pubkey-hash or a pay-to-script-hash script according to the
+// commitment.
 func (c *commitmentConverter) paymentScript(commitmentScript []byte) []byte {
 	commitmentHash := extractTicketCommitHash(commitmentScript)
 	if isTicketCommitP2SH(commitmentScript) {
diff --git a/internal/blockchain/error.go b/internal/blockchain/error.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2014-2016 The btcsuite developers
-// Copyright (c) 2015-2023 The Decred developers
+// Copyright (c) 2015-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -300,7 +300,7 @@ const (
 	// have a valid missed sstx input as per the stake ticket database.
 	ErrInvalidSSRtx = ErrorKind("ErrInvalidSSRtx")
 
-	// ErrInvalidRevNum indicates that the number of revocations from the
+	// ErrRevocationsMismatch indicates that the number of revocations from the
 	// header was not the same as the number of SSRtx included in the block.
 	ErrRevocationsMismatch = ErrorKind("ErrRevocationsMismatch")
 
@@ -331,7 +331,7 @@ const (
 	// to the same script type required by the commitment.
 	ErrBadPayeeScriptType = ErrorKind("ErrBadPayeeScriptType")
 
-	// ErrBadPayeeScriptType indicates that either a vote or revocation
+	// ErrMismatchedPayeeHash indicates that either a vote or revocation
 	// transaction output that corresponds to a ticket commitment does not pay
 	// to the hash required by the commitment.
 	ErrMismatchedPayeeHash = ErrorKind("ErrMismatchedPayeeHash")
diff --git a/internal/blockchain/mediantime.go b/internal/blockchain/mediantime.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2013-2014 The btcsuite developers
-// Copyright (c) 2015-2016 The Decred developers
+// Copyright (c) 2015-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -13,9 +13,9 @@ import (
 )
 
 const (
-	// maxAllowedOffsetSeconds is the maximum number of seconds in either
-	// direction that local clock will be adjusted.  When the median time
-	// of the network is outside of this range, no offset will be applied.
+	// maxAllowedOffsetSecs is the maximum number of seconds in either direction
+	// that local clock will be adjusted.  When the median time of the network
+	// is outside of this range, no offset will be applied.
 	maxAllowedOffsetSecs = 70 * 60 // 1 hour 10 minutes
 
 	// similarTimeSecs is the number of seconds in either direction from the
diff --git a/internal/mining/mining.go b/internal/mining/mining.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2014-2016 The btcsuite developers
-// Copyright (c) 2015-2025 The Decred developers
+// Copyright (c) 2015-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -283,8 +283,8 @@ const (
 	kilobyte = 1000
 )
 
-// containsTx is a helper function that checks to see if a list of transactions
-// contains any of the TxIns of some transaction.
+// containsTxIns is a helper function that checks to see if a list of
+// transactions contains any of the TxIns of some transaction.
 func containsTxIns(txs []*dcrutil.Tx, tx *dcrutil.Tx) bool {
 	for _, txToCheck := range txs {
 		for _, txIn := range tx.MsgTx().TxIn {
@@ -448,7 +448,7 @@ func mergeUtxoView(viewA *blockchain.UtxoViewpoint, viewB *blockchain.UtxoViewpo
 	}
 }
 
-// hashExistsInList checks if a hash exists in a list of hash pointers.
+// hashInSlice checks if a hash exists in a list of hash pointers.
 func hashInSlice(h chainhash.Hash, list []chainhash.Hash) bool {
 	for i := range list {
 		if h == list[i] {
diff --git a/internal/mining/txpriorityqueue.go b/internal/mining/txpriorityqueue.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2014-2016 The btcsuite developers
-// Copyright (c) 2015-2022 The Decred developers
+// Copyright (c) 2015-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -93,7 +93,7 @@ const (
 	votePriority
 )
 
-// stakePriority assigns a stake priority based on a transaction type.
+// txStakePriority assigns a stake priority based on a transaction type.
 func txStakePriority(txType stake.TxType, autoRevocation bool) stakePriority {
 	prio := regOrRevocPriority
 	switch {
diff --git a/internal/rpcserver/rpcserver.go b/internal/rpcserver/rpcserver.go
@@ -4666,7 +4666,7 @@ func feeInfoForMempool(s *Server, txType stake.TxType) *types.FeeInfoMempool {
 	}
 }
 
-// calcFee calculates the fee of a transaction that has its fraud proofs
+// calcFeePerKb calculates the fee of a transaction that has its fraud proofs
 // properly set.
 func calcFeePerKb(tx *dcrutil.Tx) dcrutil.Amount {
 	var in dcrutil.Amount
diff --git a/internal/rpcserver/rpcwebsocket.go b/internal/rpcserver/rpcwebsocket.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2013-2016 The btcsuite developers
-// Copyright (c) 2015-2025 The Decred developers
+// Copyright (c) 2015-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -2226,7 +2226,7 @@ func handleStopNotifyTSpend(_ context.Context, wsc *wsClient, _ any) (any, error
 	return nil, nil
 }
 
-// handleNotifyNewTransations implements the notifynewtransactions command
+// handleNotifyNewTransactions implements the notifynewtransactions command
 // extension for websocket connections.
 func handleNotifyNewTransactions(_ context.Context, wsc *wsClient, icmd any) (any, error) {
 	cmd, ok := icmd.(*types.NotifyNewTransactionsCmd)
@@ -2239,7 +2239,7 @@ func handleNotifyNewTransactions(_ context.Context, wsc *wsClient, icmd any) (an
 	return nil, nil
 }
 
-// handleStopNotifyNewTransations implements the stopnotifynewtransactions
+// handleStopNotifyNewTransactions implements the stopnotifynewtransactions
 // command extension for websocket connections.
 func handleStopNotifyNewTransactions(_ context.Context, wsc *wsClient, _ any) (any, error) {
 	wsc.rpcServer.ntfnMgr.UnregisterNewMempoolTxsUpdates(wsc)
diff --git a/peer/peer.go b/peer/peer.go
@@ -36,7 +36,7 @@ const (
 	// outputBufferSize is the number of elements the output channels use.
 	outputBufferSize = 5000
 
-	// invTrickleSize is the maximum amount of inventory to send in a single
+	// maxInvTrickleSize is the maximum amount of inventory to send in a single
 	// message when trickling inventory to remote peers.
 	maxInvTrickleSize = 1000
 
@@ -62,9 +62,9 @@ const (
 	// only checked on each stall tick interval.
 	stallResponseTimeout = 30 * time.Second
 
-	// minInvTrickleSize and maxInvTrickleSize define the lower and upper
-	// limits, respectively, of random delay waited while batching
-	// inventory before it is trickled to a peer.
+	// minInvTrickleTimeout and maxInvTrickleTimeout define the lower and upper
+	// limits, respectively, of random delay waited while batching inventory
+	// before it is trickled to a peer.
 	minInvTrickleTimeout = 100 * time.Millisecond
 	maxInvTrickleTimeout = 500 * time.Millisecond
 
@@ -375,7 +375,7 @@ const (
 	// sccHandlerStart indicates a callback handler is about to be invoked.
 	sccHandlerStart
 
-	// sccHandlerStart indicates a callback handler has completed.
+	// sccHandlerDone indicates a callback handler has completed.
 	sccHandlerDone
 )
 
diff --git a/rpc/jsonrpc/types/chainsvrcmds.go b/rpc/jsonrpc/types/chainsvrcmds.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2014 The btcsuite developers
-// Copyright (c) 2015-2024 The Decred developers
+// Copyright (c) 2015-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -920,7 +920,7 @@ func NewReconsiderBlockCmd(hash string) *ReconsiderBlockCmd {
 	}
 }
 
-// SendRawMixMessage defines the sendrawmixmessage JSON-RPC command.
+// SendRawMixMessageCmd defines the sendrawmixmessage JSON-RPC command.
 type SendRawMixMessageCmd struct {
 	Command string
 	Message string
diff --git a/rpcadaptors.go b/rpcadaptors.go
@@ -413,7 +413,7 @@ func (b *rpcSyncMgr) SubmitBlock(block *dcrutil.Block) error {
 	return b.syncMgr.ProcessBlock(block)
 }
 
-// SyncPeer returns the id of the current peer being synced with.
+// SyncPeerID returns the id of the current peer being synced with.
 //
 // This function is safe for concurrent access and is part of the
 // rpcserver.SyncManager interface implementation.
diff --git a/txscript/error.go b/txscript/error.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2013-2017 The btcsuite developers
-// Copyright (c) 2015-2022 The Decred developers
+// Copyright (c) 2015-2026 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -50,10 +50,10 @@ const (
 	// a script that has not finished executing.
 	ErrScriptUnfinished = ErrorKind("ErrScriptUnfinished")
 
-	// ErrScriptDone is returned when an attempt to execute an opcode is
-	// made once all of them have already been executed.  This can happen
-	// due to things such as a second call to Execute or calling Step after
-	// all opcodes have already been executed.
+	// ErrInvalidProgramCounter is returned when an attempt to execute an opcode
+	// is made once all of them have already been executed.  This can happen due
+	// to things such as a second call to Execute or calling Step after all
+	// opcodes have already been executed.
 	ErrInvalidProgramCounter = ErrorKind("ErrInvalidProgramCounter")
 
 	// -----------------------------------------------------
@@ -115,7 +115,7 @@ const (
 	// true.
 	ErrCheckSigVerify = ErrorKind("ErrCheckSigVerify")
 
-	// ErrCheckSigVerify is returned when OP_CHECKMULTISIGVERIFY is
+	// ErrCheckMultiSigVerify is returned when OP_CHECKMULTISIGVERIFY is
 	// encountered in a script and the top item on the data stack does not
 	// evaluate to true.
 	ErrCheckMultiSigVerify = ErrorKind("ErrCheckMultiSigVerify")
@@ -178,7 +178,7 @@ const (
 	// divide by zero.
 	ErrDivideByZero = ErrorKind("ErrDivideByZero")
 
-	// ErrNegativeRotation is returned when an OP_LSHIFT or OP_RSHIFT opcode
+	// ErrNegativeShift is returned when an OP_LSHIFT or OP_RSHIFT opcode
 	// attempts to perform a shift with a negative count.
 	ErrNegativeShift = ErrorKind("ErrNegativeShift")
 
diff --git a/wire/common.go b/wire/common.go
@@ -87,7 +87,7 @@ func (l binaryFreeList) Return(buf []byte) {
 // deserializing primitive integer values to and from io.Readers and io.Writers.
 var binarySerializer binaryFreeList = make(chan []byte, binaryFreeListMaxItems)
 
-// errNonCanonicalVarInt is the common format string used for non-canonically
+// nonCanonicalVarIntFormat is the common format string used for non-canonically
 // encoded variable length integer errors.
 var nonCanonicalVarIntFormat = "non-canonical varint %x - discriminant " +
 	"%x must encode a value greater than %x"
diff --git a/wire/error.go b/wire/error.go

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright (c) 2024 The Decred developers`
	`1`	`+// Copyright (c) 2024-2026 The Decred developers`
`2`	`2`	`// Use of this source code is governed by an ISC`
`3`	`3`	`// license that can be found in the LICENSE file.`
`4`	`4`	`//`
`@@ -228,8 +228,7 @@ func (p *PRNG) Shuffle(n int, swap func(i, j int)) {`
`228`	`228`	`}`
`229`	`229`	`}`
`230`	`230`
`231`		`-// Int returns a uniform random value in [0,max).`
`232`		`-// Panics if max <= 0.`
	`231`	`+// BigInt returns a uniform random value in [0,max). Panics if max <= 0.`
`233`	`232`	`func (p PRNG) BigInt(max big.Int) *big.Int {`
`234`	`233`	`// Will never error with our reader.`
`235`	`234`	`n, _ := rand.Int(p, max)`