docs: add comments for all functions

xray/process.go

@@ -18,46 +18,57 @@ import (
 	"github.com/mhsanaei/3x-ui/v2/util/common"
 )
 
+// GetBinaryName returns the Xray binary filename for the current OS and architecture.
 func GetBinaryName() string {
 	return fmt.Sprintf("xray-%s-%s", runtime.GOOS, runtime.GOARCH)
 }
 
+// GetBinaryPath returns the full path to the Xray binary executable.
 func GetBinaryPath() string {
 	return config.GetBinFolderPath() + "/" + GetBinaryName()
 }
 
+// GetConfigPath returns the path to the Xray configuration file in the binary folder.
 func GetConfigPath() string {
 	return config.GetBinFolderPath() + "/config.json"
 }
 
+// GetGeositePath returns the path to the geosite data file used by Xray.
 func GetGeositePath() string {
 	return config.GetBinFolderPath() + "/geosite.dat"
 }
 
+// GetGeoipPath returns the path to the geoip data file used by Xray.
 func GetGeoipPath() string {
 	return config.GetBinFolderPath() + "/geoip.dat"
 }
 
+// GetIPLimitLogPath returns the path to the IP limit log file.
 func GetIPLimitLogPath() string {
 	return config.GetLogFolder() + "/3xipl.log"
 }
 
+// GetIPLimitBannedLogPath returns the path to the banned IP log file.
 func GetIPLimitBannedLogPath() string {
 	return config.GetLogFolder() + "/3xipl-banned.log"
 }
 
+// GetIPLimitBannedPrevLogPath returns the path to the previous banned IP log file.
 func GetIPLimitBannedPrevLogPath() string {
 	return config.GetLogFolder() + "/3xipl-banned.prev.log"
 }
 
+// GetAccessPersistentLogPath returns the path to the persistent access log file.
 func GetAccessPersistentLogPath() string {
 	return config.GetLogFolder() + "/3xipl-ap.log"
 }
 
+// GetAccessPersistentPrevLogPath returns the path to the previous persistent access log file.
 func GetAccessPersistentPrevLogPath() string {
 	return config.GetLogFolder() + "/3xipl-ap.prev.log"
 }
 
+// GetAccessLogPath reads the Xray config and returns the access log file path.
 func GetAccessLogPath() (string, error) {
 	config, err := os.ReadFile(GetConfigPath())
 	if err != nil {
@@ -82,14 +93,17 @@ func GetAccessLogPath() (string, error) {
 	return "", err
 }
 
+// stopProcess calls Stop on the given Process instance.
 func stopProcess(p *Process) {
 	p.Stop()
 }
 
+// Process wraps an Xray process instance and provides management methods.
 type Process struct {
 	*process
 }
 
+// NewProcess creates a new Xray process and sets up cleanup on garbage collection.
 func NewProcess(xrayConfig *Config) *Process {
 	p := &Process{newProcess(xrayConfig)}
 	runtime.SetFinalizer(p, stopProcess)
@@ -110,6 +124,7 @@ type process struct {
 	startTime time.Time
 }
 
+// newProcess creates a new internal process struct for Xray.
 func newProcess(config *Config) *process {
 	return &process{
 		version:   "Unknown",
@@ -119,6 +134,7 @@ func newProcess(config *Config) *process {
 	}
 }
 
+// IsRunning returns true if the Xray process is currently running.
 func (p *process) IsRunning() bool {
 	if p.cmd == nil || p.cmd.Process == nil {
 		return false
@@ -129,10 +145,12 @@ func (p *process) IsRunning() bool {
 	return false
 }
 
+// GetErr returns the last error encountered by the Xray process.
 func (p *process) GetErr() error {
 	return p.exitErr
 }
 
+// GetResult returns the last log line or error from the Xray process.
 func (p *process) GetResult() string {
 	if len(p.logWriter.lastLine) == 0 && p.exitErr != nil {
 		return p.exitErr.Error()
@@ -140,30 +158,37 @@ func (p *process) GetResult() string {
 	return p.logWriter.lastLine
 }
 
+// GetVersion returns the version string of the Xray process.
 func (p *process) GetVersion() string {
 	return p.version
 }
 
+// GetAPIPort returns the API port used by the Xray process.
 func (p *Process) GetAPIPort() int {
 	return p.apiPort
 }
 
+// GetConfig returns the configuration used by the Xray process.
 func (p *Process) GetConfig() *Config {
 	return p.config
 }
 
+// GetOnlineClients returns the list of online clients for the Xray process.
 func (p *Process) GetOnlineClients() []string {
 	return p.onlineClients
 }
 
+// SetOnlineClients sets the list of online clients for the Xray process.
 func (p *Process) SetOnlineClients(users []string) {
 	p.onlineClients = users
 }
 
+// GetUptime returns the uptime of the Xray process in seconds.
 func (p *Process) GetUptime() uint64 {
 	return uint64(time.Since(p.startTime).Seconds())
 }
 
+// refreshAPIPort updates the API port from the inbound configs.
 func (p *process) refreshAPIPort() {
 	for _, inbound := range p.config.InboundConfigs {
 		if inbound.Tag == "api" {
@@ -173,6 +198,7 @@ func (p *process) refreshAPIPort() {
 	}
 }
 
+// refreshVersion updates the version string by running the Xray binary with -version.
 func (p *process) refreshVersion() {
 	cmd := exec.Command(GetBinaryPath(), "-version")
 	data, err := cmd.Output()
@@ -188,6 +214,7 @@ func (p *process) refreshVersion() {
 	}
 }
 
+// Start launches the Xray process with the current configuration.
 func (p *process) Start() (err error) {
 	if p.IsRunning() {
 		return errors.New("xray is already running")
@@ -245,6 +272,7 @@ func (p *process) Start() (err error) {
 	return nil
 }
 
+// Stop terminates the running Xray process.
 func (p *process) Stop() error {
 	if !p.IsRunning() {
 		return errors.New("xray is not running")
@@ -257,6 +285,7 @@ func (p *process) Stop() error {
 	}
 }
 
+// writeCrashReport writes a crash report to the binary folder with a timestamped filename.
 func writeCrashReport(m []byte) error {
 	crashReportPath := config.GetBinFolderPath() + "/core_crash_" + time.Now().Format("20060102_150405") + ".log"
 	return os.WriteFile(crashReportPath, m, os.ModePerm)