LaconicNetwork/cosmos-sdk
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
runtime/events.go
+4 -4
View File
@@ -34,12 +34,12 @@ func NewEventManager(ctx context.Context) event.Manager {
// Emit emits an typed event that is defined in the protobuf file.
// In the future these events will be added to consensus.
func (e Events) Emit(ctx context.Context, event protoiface.MessageV1) error {
func (e Events) Emit(_ context.Context, event protoiface.MessageV1) error {
return e.EmitTypedEvent(event)
}
// EmitKV emits a key value pair event.
func (e Events) EmitKV(ctx context.Context, eventType string, attrs ...event.Attribute) error {
func (e Events) EmitKV(_ context.Context, eventType string, attrs ...event.Attribute) error {
attributes := make([]sdk.Attribute, 0, len(attrs))
for _, attr := range attrs {
@@ -50,8 +50,8 @@ func (e Events) EmitKV(ctx context.Context, eventType string, attrs ...event.Att
return nil
}
// Emit emits an typed event that is defined in the protobuf file.
// EmitNonConsensus emits an typed event that is defined in the protobuf file.
// In the future these events will be added to consensus.
func (e Events) EmitNonConsensus(ctx context.Context, event protoiface.MessageV1) error {
func (e Events) EmitNonConsensus(_ context.Context, event protoiface.MessageV1) error {
return e.EmitTypedEvent(event)
}
runtime/types.go
+9 -9
View File
@@ -11,31 +11,31 @@ import (
const ModuleName = "runtime"
// App implements the common methods for a Cosmos SDK-based application
// AppI implements the common methods for a Cosmos SDK-based application
// specific blockchain.
type AppI interface {
// The assigned name of the app.
// Name is the assigned name of the app.
Name() string
// The application types codec.
// LegacyAmino is the application types codec.
// NOTE: This should NOT be sealed before being returned.
LegacyAmino() *codec.LegacyAmino
// Application updates every begin block.
// BeginBlocker is logic run every begin block.
BeginBlocker(ctx sdk.Context) (sdk.BeginBlock, error)
// Application updates every end block.
// EndBlocker is logic run every end block.
EndBlocker(ctx sdk.Context) (sdk.EndBlock, error)
// Application update at chain (i.e app) initialization.
// InitChainer is the application update at chain (i.e app) initialization.
InitChainer(ctx sdk.Context, req *abci.InitChainRequest) (*abci.InitChainResponse, error)
// Loads the app at a given height.
// LoadHeight loads the app at a given height.
LoadHeight(height int64) error
// Exports the state of the application for a genesis file.
// ExportAppStateAndValidators exports the state of the application for a genesis file.
ExportAppStateAndValidators(forZeroHeight bool, jailAllowedAddrs, modulesToExport []string) (types.ExportedApp, error)
// Helper for the simulation framework.
// SimulationManager is a helper for the simulation framework.
SimulationManager() *module.SimulationManager
}