LogalDeveloper/owncast
0
Fork 0
Code Activity

Fix godoc style comments (#356)

Browse Source
This commit is contained in:
Christian Muehlhaeuser
2020-11-13 00:14:59 +01:00
committed by GitHub
parent 8f921fbfde
commit 2e1f8d29b5
59 changed files with 147 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
config/config.go
View File

@@ -11,7 +11,7 @@ import (
"gopkg.in/yaml.v2"
)
//Config contains a reference to the configuration
// Config contains a reference to the configuration.
var Config *config
var _default config
@@ -91,7 +91,7 @@ type files struct {
MaxNumberInPlaylist int `yaml:"maxNumberInPlaylist"`
}
//S3 is for configuring the S3 integration
// S3 is for configuring the S3 integration.
type S3 struct {
Enabled bool `yaml:"enabled" json:"enabled"`
Endpoint string `yaml:"endpoint" json:"endpoint,omitempty"`
@@ -229,7 +229,7 @@ func (c *config) GetVideoStreamQualities() []StreamQuality {
return _default.VideoSettings.StreamQualities
}
// GetFramerate returns the framerate or default
// GetFramerate returns the framerate or default.
func (q *StreamQuality) GetFramerate() int {
if q.Framerate > 0 {
return q.Framerate
@@ -238,7 +238,7 @@ func (q *StreamQuality) GetFramerate() int {
return _default.VideoSettings.StreamQualities[0].Framerate
}
// GetEncoderPreset returns the preset or default
// GetEncoderPreset returns the preset or default.
func (q *StreamQuality) GetEncoderPreset() string {
if q.EncoderPreset != "" {
return q.EncoderPreset
@@ -247,7 +247,7 @@ func (q *StreamQuality) GetEncoderPreset() string {
return _default.VideoSettings.StreamQualities[0].EncoderPreset
}
//Load tries to load the configuration file
// Load tries to load the configuration file.
func Load(filePath string, versionInfo string, versionNumber string) error {
Config = new(config)
_default = getDefaults()

2
config/configUtils.go
View File

@@ -36,7 +36,7 @@ func findHighestQuality(qualities []StreamQuality) int {
return indexedQualities[0].index
}
// MarshalJSON is a custom JSON marshal function for video stream qualities
// MarshalJSON is a custom JSON marshal function for video stream qualities.
func (q *StreamQuality) MarshalJSON() ([]byte, error) {
type Alias StreamQuality
return json.Marshal(&struct {

2
config/verifyInstall.go
View File

@@ -6,7 +6,7 @@ import (
"os"
)
//verifyFFMpegPath verifies that the path exists, is a file, and is executable
// verifyFFMpegPath verifies that the path exists, is a file, and is executable.
func verifyFFMpegPath(path string) error {
stat, err := os.Stat(path)