docs: add descriptions for types

docs-types
sammyette 2023-01-07 14:25:57 -04:00
parent 731b3db2de
commit a64f946055
Signed by: sammyette
GPG Key ID: 904FC49417B44DCD
4 changed files with 4 additions and 4 deletions

View File

@ -35,7 +35,7 @@ Returns the last added job from the table.
## Types ## Types
## Job ## Job
Job Type. The Job type describes a Hilbish job.
### Properties ### Properties
- `cmd`: The user entered command string for the job. - `cmd`: The user entered command string for the job.
- `running`: Whether the job is running or not. - `running`: Whether the job is running or not.

View File

@ -44,7 +44,7 @@ Retrieves a timer via its ID.
## Types ## Types
## Timer ## Timer
Timer type. The Job type describes a Hilbish timer.
### Properties ### Properties
- `type`: What type of timer it is - `type`: What type of timer it is
- `running`: If the timer is running - `running`: If the timer is running

2
job.go
View File

@ -26,7 +26,7 @@ var jobMetaKey = rt.StringValue("hshjob")
// #property exitCode The last exit code of the job. // #property exitCode The last exit code of the job.
// #property stdout The standard output of the job. This just means the normal logs of the process. // #property stdout The standard output of the job. This just means the normal logs of the process.
// #property stderr The standard error stream of the process. This (usually) includes error messages of the job. // #property stderr The standard error stream of the process. This (usually) includes error messages of the job.
// Job Type. // The Job type describes a Hilbish job.
type job struct { type job struct {
cmd string cmd string
running bool running bool

View File

@ -19,7 +19,7 @@ const (
// #property type What type of timer it is // #property type What type of timer it is
// #property running If the timer is running // #property running If the timer is running
// #property duration The duration in milliseconds that the timer will run // #property duration The duration in milliseconds that the timer will run
// Timer type. // The Job type describes a Hilbish timer.
type timer struct{ type timer struct{
id int id int
typ timerType typ timerType