doc: adding godoc style comments for APIs

Author: RawanMostafa08

pkg/cpuInfo.go

@@ -1,3 +1,4 @@
+// psutils package implements a human-friendly lib for querying processes, memory info and cpu info
 package psutils
 
 import (
@@ -7,15 +8,16 @@ import (
 )
 
 type Loader interface {
-	Load(filePath string) (string, error)
+	load(filePath string) (string, error)
 }
 
-type RealCpuLoader struct{}
+type realCpuLoader struct{}
 
-func (l *RealCpuLoader) Load(filePath string) (string, error) {
+func (l *realCpuLoader) load(filePath string) (string, error) {
 	return loadFile(filePath)
 }
 
+// CpuInfo holds some details about the CPU like number of cores, vendorID, model name, cache size, average CPU frequency
 type CpuInfo struct {
 	NumCores  int
 	VendorId  string
@@ -65,14 +67,15 @@ func setCpuInfo(cpuData string) (cpuInfo CpuInfo, err error) {
 	return
 }
 
+// GetCpuInfo returns a CpuInfo type about the CPU in this moment
 func GetCpuInfo() (cpuInfo CpuInfo, err error) {
-	var _ Loader = (*RealCpuLoader)(nil)
-	return getCpuInfo(&RealCpuLoader{})
+	var _ Loader = (*realCpuLoader)(nil)
+	return getCpuInfo(&realCpuLoader{})
 }
 
 func getCpuInfo(loader Loader) (cpuInfo CpuInfo, err error) {
 
-	cpuData, err := loader.Load("/proc/cpuinfo")
+	cpuData, err := loader.load("/proc/cpuinfo")
 	if err != nil {
 		return
 	}

pkg/memInfo.go

@@ -1,19 +1,21 @@
+// psutils package implements a human-friendly lib for querying processes, memory info and cpu info
 package psutils
 
 import (
 	"strconv"
 	"strings"
 )
 
+// MemInfo holds some info about the memory like total,used and availabe memory in KiloBytes
 type MemInfo struct {
 	TotalMemoryKB     float64
 	UsedMemoryKB      float64
 	AvailableMemoryKB float64
 }
 
-type RealMemLoader struct{}
+type realMemLoader struct{}
 
-func (l *RealMemLoader) Load(filePath string) (string, error) {
+func (l *realMemLoader) load(filePath string) (string, error) {
 	return loadFile(filePath)
 }
 
@@ -49,14 +51,15 @@ func setMemInfo(memData string) (memInfo MemInfo, err error) {
 	return
 }
 
+// GetMemInfo returns a MemInfo type of the memory in this moment
 func GetMemInfo() (memInfo MemInfo, err error) {
-	var _ Loader = (*RealMemLoader)(nil)
-	return getMemInfo(&RealMemLoader{})
+	var _ Loader = (*realMemLoader)(nil)
+	return getMemInfo(&realMemLoader{})
 }
 
 func getMemInfo(loader Loader) (memInfo MemInfo, err error) {
 
-	memData, err := loader.Load("/proc/meminfo")
+	memData, err := loader.load("/proc/meminfo")
 	if err != nil {
 		return
 	}

pkg/processInfo.go

@@ -1,28 +1,30 @@
+// psutils package implements a human-friendly lib for querying processes, memory info and cpu info
 package psutils
 
-import "fmt"
-
 import (
+	"fmt"
 	"os"
 	"path/filepath"
 	"strconv"
 	"strings"
 )
 
+// Process holds the basic information about a process, like its Pid and name
 type Process struct {
 	PID         int
 	ProcessName string
 }
 
+// ProcessDetails holds more detailed information about a process, like its State, PPid, Tgid
 type ProcessDetails struct {
 	State string
 	PPID  int
 	Tgid  int
 }
 
-type RealProcLoader struct{}
+type realProcLoader struct{}
 
-func (l *RealProcLoader) Load(filePath string) (string, error) {
+func (l *realProcLoader) load(filePath string) (string, error) {
 	return loadFile(filePath)
 }
 
@@ -60,9 +62,10 @@ func setProcInfo(data string) (proc Process, procDetails ProcessDetails, err err
 	return
 }
 
+// GetProcessList returns a list of all currently running processes and an error if exists
 func GetProcessList() (procs []Process, err error) {
-	var _ Loader = (*RealProcLoader)(nil)
-	return getProcessList(&RealProcLoader{})
+	var _ Loader = (*realProcLoader)(nil)
+	return getProcessList(&realProcLoader{})
 }
 
 func getProcessList(loader Loader) (procs []Process, err error) {
@@ -87,7 +90,7 @@ func getProcessList(loader Loader) (procs []Process, err error) {
 
 		statusFile := filepath.Join("/proc", entry, "status")
 		var data string
-		data, err = loader.Load(statusFile)
+		data, err = loader.load(statusFile)
 		if err != nil {
 			return
 		}
@@ -101,16 +104,18 @@ func getProcessList(loader Loader) (procs []Process, err error) {
 	return
 }
 
+// GetProcessDetails takes a PID as an argument
+// and returns its details as ProcessDetails type, and an error if exists
 func GetProcessDetails(PID int) (ProcessDetails ProcessDetails, err error) {
-	var _ Loader = (*RealProcLoader)(nil)
-	return getProcessDetails(PID, &RealProcLoader{})
+	var _ Loader = (*realProcLoader)(nil)
+	return getProcessDetails(PID, &realProcLoader{})
 }
 
 func getProcessDetails(PID int, loader Loader) (ProcessDetails ProcessDetails, err error) {
 
 	statusFile := filepath.Join("/proc", fmt.Sprint(PID), "status")
 	var data string
-	data, err = loader.Load(statusFile)
+	data, err = loader.load(statusFile)
 	if err != nil {
 		return
 	}