Add doc

danielpaulus · Oct 24, 2024 · 8567537 · 8567537
1 parent 456904f
commit 8567537
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/ios/diagnostics/request.go b/ios/diagnostics/request.go
@@ -37,6 +37,7 @@ type Diagnostics struct {
 	IORegistry IORegistry
 }
 
+// IORegistry relates to the battery stats
 type IORegistry struct {
 	InstantAmperage int
 	Temperature     int

diff --git a/ios/dtx_codec/channel.go b/ios/dtx_codec/channel.go
@@ -132,6 +132,7 @@ func (d *Channel) SendAndAwaitReply(expectsReply bool, messageType MessageType,
 	}
 }
 
+// Receive receives a message from a global channel (0)
 func (d *Channel) Receive() (Message, error) {
 	select {
 	case response := <-d.messageReceiver.msgChannel:

diff --git a/ios/instruments/instruments_sysmontap.go b/ios/instruments/instruments_sysmontap.go
@@ -15,6 +15,7 @@ type SysmontapService struct {
 	plistCodec ios.PlistCodec
 }
 
+// Creates a new SysmontapService
 func NewSysmontapService(device ios.DeviceEntry) (*SysmontapService, error) {
 	dtxConn, err := connectInstruments(device)
 	if err != nil {
@@ -53,6 +54,7 @@ func (s *SysmontapService) Start() (SysmontapMessage, error) {
 	return sysmontapMessage, nil
 }
 
+// SetConfig sets configuration to allow the sysmontap service getting desired data points
 func (s *SysmontapService) SetConfig(procAttrs, sysAttrs []interface{}) error {
 	config := map[string]interface{}{
 		"ur":             500,