config comment tweaks

This commit is contained in:
Athou
2024-08-14 21:34:05 +02:00
parent d612d83874
commit e757e61b79

View File

@@ -15,7 +15,7 @@ import jakarta.validation.constraints.Positive;
/** /**
* CommaFeed configuration * CommaFeed configuration
* *
* Default values are for production, they can be overridden in application.properties * Default values are for production, they can be overridden in application.properties for other profiles
*/ */
@ConfigMapping(prefix = "commafeed") @ConfigMapping(prefix = "commafeed")
public interface CommaFeedConfiguration { public interface CommaFeedConfiguration {
@@ -52,7 +52,7 @@ public interface CommaFeedConfiguration {
Optional<String> googleAnalyticsTrackingCode(); Optional<String> googleAnalyticsTrackingCode();
/** /**
* Google Auth key for fetching Youtube favicons. * Google Auth key for fetching Youtube channel favicons.
*/ */
Optional<String> googleAuthKey(); Optional<String> googleAuthKey();
@@ -127,6 +127,8 @@ public interface CommaFeedConfiguration {
interface Database { interface Database {
/** /**
* Database query timeout. * Database query timeout.
*
* 0 to disable.
*/ */
@WithDefault("0") @WithDefault("0")
int queryTimeout(); int queryTimeout();
@@ -201,7 +203,7 @@ public interface CommaFeedConfiguration {
interface Websocket { interface Websocket {
/** /**
* Enable websocket connection so the server can notify the web client that there are new entries for your feeds. * Enable websocket connection so the server can notify web clients that there are new entries for feeds.
*/ */
@WithDefault("true") @WithDefault("true")
boolean enabled(); boolean enabled();