Skip to content

Commit

Permalink
Feature/godoc for category clients (#21)
Browse files Browse the repository at this point in the history
* internal/comments: add period to godoc comments for category clients

* generate

Co-authored-by: Andrey Kaipov <andreykaipov@users.noreply.github.com>
  • Loading branch information
andreykaipov and andreykaipov authored Aug 17, 2021
1 parent 1163010 commit dd4892c
Show file tree
Hide file tree
Showing 15 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion api/requests/general/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package general

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'general' requests
// Client represents a client for 'general' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion api/requests/media_control/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package mediacontrol

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'media control' requests
// Client represents a client for 'media control' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion api/requests/outputs/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package outputs

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'outputs' requests
// Client represents a client for 'outputs' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion api/requests/profiles/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package profiles

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'profiles' requests
// Client represents a client for 'profiles' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion api/requests/recording/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package recording

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'recording' requests
// Client represents a client for 'recording' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion api/requests/replay_buffer/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package replaybuffer

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'replay buffer' requests
// Client represents a client for 'replay buffer' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion api/requests/scene_collections/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package scenecollections

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'scene collections' requests
// Client represents a client for 'scene collections' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion api/requests/scene_items/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package sceneitems

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'scene items' requests
// Client represents a client for 'scene items' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion api/requests/scenes/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package scenes

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'scenes' requests
// Client represents a client for 'scenes' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion api/requests/sources/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package sources

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'sources' requests
// Client represents a client for 'sources' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion api/requests/streaming/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package streaming

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'streaming' requests
// Client represents a client for 'streaming' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion api/requests/studio_mode/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package studiomode

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'studio mode' requests
// Client represents a client for 'studio mode' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion api/requests/transitions/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package transitions

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'transitions' requests
// Client represents a client for 'transitions' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion api/requests/virtual_cam/zz_generated.client.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ package virtualcam

import requests "github.com/andreykaipov/goobs/api/requests"

// Client represents a client for 'virtual cam' requests
// Client represents a client for 'virtual cam' requests.
type Client struct {
*requests.Client
}
2 changes: 1 addition & 1 deletion internal/comments/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ func generateRequests(data *Comments) {
// Generate the category-level client
client := NewFile(categoryClaustrophic)
client.HeaderComment("This file has been automatically generated. Don't edit it.")
client.Commentf("Client represents a client for '%s' requests", category)
client.Commentf("Client represents a client for '%s' requests.", category)
client.Add(
Type().Id("Client").Struct(
Op("*").Qual(goobs+"/api/requests", "Client"),
Expand Down

0 comments on commit dd4892c

Please sign in to comment.