Skip to content

Commit

Permalink
fixed doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
FerroO2000 committed Apr 12, 2024
1 parent 9b30cec commit dc4c8e4
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
10 changes: 5 additions & 5 deletions attribute.go
Original file line number Diff line number Diff line change
Expand Up @@ -101,21 +101,21 @@ type Attribute interface {
// CreateTime returns the time of creation of an attribute.
CreateTime() time.Time

// Kind returns the [AttributeKind] of an attribute.
// Kind returns the kind of an attribute.
Kind() AttributeKind

addReference(ref *AttributeRef)
removeReference(refID EntityID)
// References returns a slice of references of an attribute.
References() []*AttributeRef

// ToString converts the attribute to a [StringAttribute].
// ToString converts the attribute to a string attribute.
ToString() (*StringAttribute, error)
// ToInteger converts the attribute to a [IntegerAttribute].
// ToInteger converts the attribute to a integer attribute.
ToInteger() (*IntegerAttribute, error)
// ToFloat converts the attribute to a [FloatAttribute].
// ToFloat converts the attribute to a float attribute.
ToFloat() (*FloatAttribute, error)
// ToEnum converts the attribute to a [EnumAttribute].
// ToEnum converts the attribute to a enum attribute.
ToEnum() (*EnumAttribute, error)
}

Expand Down
22 changes: 11 additions & 11 deletions signal.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const (
type SignalParent interface {
errorf(err error) error

// GetSignalParentKind return the [SignalParentKind] of the parent.
// GetSignalParentKind return the kind of the parent.
GetSignalParentKind() SignalParentKind

verifySignalName(sigID EntityID, name string) error
Expand All @@ -45,9 +45,9 @@ type SignalParent interface {
verifySignalSizeAmount(sigID EntityID, amount int) error
modifySignalSize(sigID EntityID, amount int) error

// ToParentMessage returns the signal parent as a [Message].
// ToParentMessage returns the signal parent as a message.
ToParentMessage() (*Message, error)
// ToParentMultiplexerSignal returns the signal parent as a [MultiplexerSignal].
// ToParentMultiplexerSignal returns the signal parent as a multiplexer signal.
ToParentMultiplexerSignal() (*MultiplexerSignal, error)
}

Expand All @@ -63,15 +63,15 @@ type Signal interface {
// CreateTime returns the creation time of the signal.
CreateTime() time.Time

// AddAttributeValue adds to the signal an [Attribute] and its value.
// AddAttributeValue adds to the signal an attribute and its value.
AddAttributeValue(attribute Attribute, value any) error
// RemoveAttributeValue removes from the signal an [Attribute] and its value.
// RemoveAttributeValue removes from the signal an attribute and its value.
RemoveAttributeValue(attributeEntityID EntityID) error
// RemoveAllAttributeValues removes all [Attribute] and their values from the signal.
// RemoveAllAttributeValues removes all attribute and their values from the signal.
RemoveAllAttributeValues()
// AttributeValues returns all [Attribute] and their values from the signal.
// AttributeValues returns all attribute and their values from the signal.
AttributeValues() []*AttributeValue
// GetAttributeValue returns the value of an [Attribute] and its value from the signal.
// GetAttributeValue returns the value of an attribute and its value from the signal.
GetAttributeValue(attributeEntityID EntityID) (*AttributeValue, error)

stringify(b *strings.Builder, tabs int)
Expand All @@ -92,11 +92,11 @@ type Signal interface {
// GetSize returns the size of the signal.
GetSize() int

// ToStandard returns the signal as a [StandardSignal].
// ToStandard returns the signal as a standard signal.
ToStandard() (*StandardSignal, error)
// ToEnum returns the signal as a [EnumSignal].
// ToEnum returns the signal as a enum signal.
ToEnum() (*EnumSignal, error)
// ToMultiplexer returns the signal as a [MultiplexerSignal].
// ToMultiplexer returns the signal as a multiplexer signal.
ToMultiplexer() (*MultiplexerSignal, error)
}

Expand Down

0 comments on commit dc4c8e4

Please sign in to comment.