chore: fix godoc comments for functions and structs (#24736)

This commit is contained in:
Alex | Interchain Labs
2025-05-13 13:48:13 +00:00
committed by GitHub
parent bedfc39334
commit a2d6d1f6ac
141 changed files with 461 additions and 412 deletions
+5
View File
@@ -17,6 +17,11 @@ func RequireProof(subpath string) bool {
//-----------------------------------------------------------------------------
// DefaultProofRuntime returns a default proof runtime for the rootMultiStore.
//
// The default proof runtime registers the commitment op decoder for IAVL and
// SimpleMerkle commitments.
//
// XXX: This should be managed by the rootMultiStore which may want to register
// more proof ops?
func DefaultProofRuntime() (prt *merkle.ProofRuntime) {
+3 -3
View File
@@ -336,7 +336,7 @@ func deleteKVStore(kv types.KVStore) error {
return nil
}
// we simulate move by a copy and delete
// moveKVStoreData implements a move by a copy and delete.
func moveKVStoreData(oldDB, newDB types.KVStore) error {
// we read from one and write to another
itr := oldDB.Iterator(nil, nil)
@@ -724,7 +724,7 @@ func (rs *Store) PruneStores(pruningHeight int64) (err error) {
return nil
}
// getStoreByName performs a lookup of a StoreKey given a store name typically
// GetStoreByName performs a lookup of a StoreKey given a store name typically
// provided in a path. The StoreKey is then used to perform a lookup and return
// a Store. If the Store is wrapped in an inter-block cache, it will be unwrapped
// prior to being returned. If the StoreKey does not exist, nil is returned.
@@ -1185,7 +1185,7 @@ func GetLatestVersion(db dbm.DB) int64 {
return latestVersion
}
// Commits each store and returns a new commitInfo.
// commitStores commits each store and returns a new commitInfo.
func commitStores(version int64, storeMap map[types.StoreKey]types.CommitKVStore, removalMap map[types.StoreKey]bool) *types.CommitInfo {
storeInfos := make([]types.StoreInfo, 0, len(storeMap))
storeKeys := keysFromStoreKeyMap(storeMap)