docs: fix invalid godoc for generated settings methods

This commit is contained in:
Mateusz Filipowicz
2025-03-02 22:27:49 +01:00
parent a5955a6358
commit bdc73a9811
41 changed files with 82 additions and 82 deletions

View File

@@ -85,7 +85,7 @@ func (c *client) list{{ .StructName }}(ctx context.Context, site string) ([]{{ .
{{- end }}
{{ if .IsSetting }}
// Update {{ .StructName }} Experimental! This function is not yet stable and may change in the future.
// Get{{ .StructName }} Experimental! This function is not yet stable and may change in the future.
func (c *client) Get{{ .StructName }}(ctx context.Context, site string) (*{{ .StructName }}, error) {
s, f, err := c.GetSetting(ctx, site, {{ .StructName }}Key)
if err != nil {

View File

@@ -49,7 +49,7 @@ func (dst *SettingAutoSpeedtest) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingAutoSpeedtest Experimental! This function is not yet stable and may change in the future.
// GetSettingAutoSpeedtest Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingAutoSpeedtest(ctx context.Context, site string) (*SettingAutoSpeedtest, error) {
s, f, err := c.GetSetting(ctx, site, SettingAutoSpeedtestKey)
if err != nil {

View File

@@ -51,7 +51,7 @@ func (dst *SettingBaresip) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingBaresip Experimental! This function is not yet stable and may change in the future.
// GetSettingBaresip Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingBaresip(ctx context.Context, site string) (*SettingBaresip, error) {
s, f, err := c.GetSetting(ctx, site, SettingBaresipKey)
if err != nil {

View File

@@ -53,7 +53,7 @@ func (dst *SettingBroadcast) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingBroadcast Experimental! This function is not yet stable and may change in the future.
// GetSettingBroadcast Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingBroadcast(ctx context.Context, site string) (*SettingBroadcast, error) {
s, f, err := c.GetSetting(ctx, site, SettingBroadcastKey)
if err != nil {

View File

@@ -53,7 +53,7 @@ func (dst *SettingConnectivity) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingConnectivity Experimental! This function is not yet stable and may change in the future.
// GetSettingConnectivity Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingConnectivity(ctx context.Context, site string) (*SettingConnectivity, error) {
s, f, err := c.GetSetting(ctx, site, SettingConnectivityKey)
if err != nil {

View File

@@ -51,7 +51,7 @@ func (dst *SettingCountry) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingCountry Experimental! This function is not yet stable and may change in the future.
// GetSettingCountry Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingCountry(ctx context.Context, site string) (*SettingCountry, error) {
s, f, err := c.GetSetting(ctx, site, SettingCountryKey)
if err != nil {

View File

@@ -70,7 +70,7 @@ func (dst *SettingDashboardWidgets) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingDashboard Experimental! This function is not yet stable and may change in the future.
// GetSettingDashboard Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingDashboard(ctx context.Context, site string) (*SettingDashboard, error) {
s, f, err := c.GetSetting(ctx, site, SettingDashboardKey)
if err != nil {

View File

@@ -72,7 +72,7 @@ func (dst *SettingDohCustomServers) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingDoh Experimental! This function is not yet stable and may change in the future.
// GetSettingDoh Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingDoh(ctx context.Context, site string) (*SettingDoh, error) {
s, f, err := c.GetSetting(ctx, site, SettingDohKey)
if err != nil {

View File

@@ -49,7 +49,7 @@ func (dst *SettingDpi) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingDpi Experimental! This function is not yet stable and may change in the future.
// GetSettingDpi Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingDpi(ctx context.Context, site string) (*SettingDpi, error) {
s, f, err := c.GetSetting(ctx, site, SettingDpiKey)
if err != nil {

View File

@@ -50,7 +50,7 @@ func (dst *SettingElementAdopt) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingElementAdopt Experimental! This function is not yet stable and may change in the future.
// GetSettingElementAdopt Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingElementAdopt(ctx context.Context, site string) (*SettingElementAdopt, error) {
s, f, err := c.GetSetting(ctx, site, SettingElementAdoptKey)
if err != nil {

View File

@@ -91,7 +91,7 @@ func (dst *SettingEtherLightingSpeedOverrides) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingEtherLighting Experimental! This function is not yet stable and may change in the future.
// GetSettingEtherLighting Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingEtherLighting(ctx context.Context, site string) (*SettingEtherLighting, error) {
s, f, err := c.GetSetting(ctx, site, SettingEtherLightingKey)
if err != nil {

View File

@@ -48,7 +48,7 @@ func (dst *SettingEvaluationScore) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingEvaluationScore Experimental! This function is not yet stable and may change in the future.
// GetSettingEvaluationScore Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingEvaluationScore(ctx context.Context, site string) (*SettingEvaluationScore, error) {
s, f, err := c.GetSetting(ctx, site, SettingEvaluationScoreKey)
if err != nil {

View File

@@ -70,7 +70,7 @@ func (dst *SettingGlobalAp) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingGlobalAp Experimental! This function is not yet stable and may change in the future.
// GetSettingGlobalAp Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingGlobalAp(ctx context.Context, site string) (*SettingGlobalAp, error) {
s, f, err := c.GetSetting(ctx, site, SettingGlobalApKey)
if err != nil {

View File

@@ -49,7 +49,7 @@ func (dst *SettingGlobalNat) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingGlobalNat Experimental! This function is not yet stable and may change in the future.
// GetSettingGlobalNat Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingGlobalNat(ctx context.Context, site string) (*SettingGlobalNat, error) {
s, f, err := c.GetSetting(ctx, site, SettingGlobalNatKey)
if err != nil {

View File

@@ -78,7 +78,7 @@ func (dst *SettingGlobalSwitchAclL3Isolation) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingGlobalSwitch Experimental! This function is not yet stable and may change in the future.
// GetSettingGlobalSwitch Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingGlobalSwitch(ctx context.Context, site string) (*SettingGlobalSwitch, error) {
s, f, err := c.GetSetting(ctx, site, SettingGlobalSwitchKey)
if err != nil {

View File

@@ -159,7 +159,7 @@ func (dst *SettingGuestAccess) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingGuestAccess Experimental! This function is not yet stable and may change in the future.
// GetSettingGuestAccess Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingGuestAccess(ctx context.Context, site string) (*SettingGuestAccess, error) {
s, f, err := c.GetSetting(ctx, site, SettingGuestAccessKey)
if err != nil {

View File

@@ -224,7 +224,7 @@ func (dst *SettingIpsWhitelist) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingIps Experimental! This function is not yet stable and may change in the future.
// GetSettingIps Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingIps(ctx context.Context, site string) (*SettingIps, error) {
s, f, err := c.GetSetting(ctx, site, SettingIpsKey)
if err != nil {

View File

@@ -57,7 +57,7 @@ func (dst *SettingLcm) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingLcm Experimental! This function is not yet stable and may change in the future.
// GetSettingLcm Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingLcm(ctx context.Context, site string) (*SettingLcm, error) {
s, f, err := c.GetSetting(ctx, site, SettingLcmKey)
if err != nil {

View File

@@ -48,7 +48,7 @@ func (dst *SettingLocale) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingLocale Experimental! This function is not yet stable and may change in the future.
// GetSettingLocale Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingLocale(ctx context.Context, site string) (*SettingLocale, error) {
s, f, err := c.GetSetting(ctx, site, SettingLocaleKey)
if err != nil {

View File

@@ -48,7 +48,7 @@ func (dst *SettingMagicSiteToSiteVpn) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingMagicSiteToSiteVpn Experimental! This function is not yet stable and may change in the future.
// GetSettingMagicSiteToSiteVpn Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingMagicSiteToSiteVpn(ctx context.Context, site string) (*SettingMagicSiteToSiteVpn, error) {
s, f, err := c.GetSetting(ctx, site, SettingMagicSiteToSiteVpnKey)
if err != nil {

View File

@@ -95,7 +95,7 @@ func (dst *SettingMgmtXSshKeys) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingMgmt Experimental! This function is not yet stable and may change in the future.
// GetSettingMgmt Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingMgmt(ctx context.Context, site string) (*SettingMgmt, error) {
s, f, err := c.GetSetting(ctx, site, SettingMgmtKey)
if err != nil {

View File

@@ -71,7 +71,7 @@ func (dst *SettingNetflow) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingNetflow Experimental! This function is not yet stable and may change in the future.
// GetSettingNetflow Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingNetflow(ctx context.Context, site string) (*SettingNetflow, error) {
s, f, err := c.GetSetting(ctx, site, SettingNetflowKey)
if err != nil {

View File

@@ -48,7 +48,7 @@ func (dst *SettingNetworkOptimization) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingNetworkOptimization Experimental! This function is not yet stable and may change in the future.
// GetSettingNetworkOptimization Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingNetworkOptimization(ctx context.Context, site string) (*SettingNetworkOptimization, error) {
s, f, err := c.GetSetting(ctx, site, SettingNetworkOptimizationKey)
if err != nil {

View File

@@ -52,7 +52,7 @@ func (dst *SettingNtp) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingNtp Experimental! This function is not yet stable and may change in the future.
// GetSettingNtp Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingNtp(ctx context.Context, site string) (*SettingNtp, error) {
s, f, err := c.GetSetting(ctx, site, SettingNtpKey)
if err != nil {

View File

@@ -48,7 +48,7 @@ func (dst *SettingPorta) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingPorta Experimental! This function is not yet stable and may change in the future.
// GetSettingPorta Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingPorta(ctx context.Context, site string) (*SettingPorta, error) {
s, f, err := c.GetSetting(ctx, site, SettingPortaKey)
if err != nil {

View File

@@ -115,7 +115,7 @@ func (dst *SettingRadioAiChannelsBlacklist) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingRadioAi Experimental! This function is not yet stable and may change in the future.
// GetSettingRadioAi Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingRadioAi(ctx context.Context, site string) (*SettingRadioAi, error) {
s, f, err := c.GetSetting(ctx, site, SettingRadioAiKey)
if err != nil {

View File

@@ -62,7 +62,7 @@ func (dst *SettingRadius) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingRadius Experimental! This function is not yet stable and may change in the future.
// GetSettingRadius Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingRadius(ctx context.Context, site string) (*SettingRadius, error) {
s, f, err := c.GetSetting(ctx, site, SettingRadiusKey)
if err != nil {

View File

@@ -63,7 +63,7 @@ func (dst *SettingRsyslogd) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingRsyslogd Experimental! This function is not yet stable and may change in the future.
// GetSettingRsyslogd Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingRsyslogd(ctx context.Context, site string) (*SettingRsyslogd, error) {
s, f, err := c.GetSetting(ctx, site, SettingRsyslogdKey)
if err != nil {

View File

@@ -52,7 +52,7 @@ func (dst *SettingSnmp) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingSnmp Experimental! This function is not yet stable and may change in the future.
// GetSettingSnmp Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingSnmp(ctx context.Context, site string) (*SettingSnmp, error) {
s, f, err := c.GetSetting(ctx, site, SettingSnmpKey)
if err != nil {

View File

@@ -48,7 +48,7 @@ func (dst *SettingSslInspection) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingSslInspection Experimental! This function is not yet stable and may change in the future.
// GetSettingSslInspection Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingSslInspection(ctx context.Context, site string) (*SettingSslInspection, error) {
s, f, err := c.GetSetting(ctx, site, SettingSslInspectionKey)
if err != nil {

View File

@@ -54,7 +54,7 @@ func (dst *SettingSuperCloudaccess) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingSuperCloudaccess Experimental! This function is not yet stable and may change in the future.
// GetSettingSuperCloudaccess Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingSuperCloudaccess(ctx context.Context, site string) (*SettingSuperCloudaccess, error) {
s, f, err := c.GetSetting(ctx, site, SettingSuperCloudaccessKey)
if err != nil {

View File

@@ -48,7 +48,7 @@ func (dst *SettingSuperEvents) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingSuperEvents Experimental! This function is not yet stable and may change in the future.
// GetSettingSuperEvents Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingSuperEvents(ctx context.Context, site string) (*SettingSuperEvents, error) {
s, f, err := c.GetSetting(ctx, site, SettingSuperEventsKey)
if err != nil {

View File

@@ -50,7 +50,7 @@ func (dst *SettingSuperFwupdate) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingSuperFwupdate Experimental! This function is not yet stable and may change in the future.
// GetSettingSuperFwupdate Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingSuperFwupdate(ctx context.Context, site string) (*SettingSuperFwupdate, error) {
s, f, err := c.GetSetting(ctx, site, SettingSuperFwupdateKey)
if err != nil {

View File

@@ -49,7 +49,7 @@ func (dst *SettingSuperIdentity) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingSuperIdentity Experimental! This function is not yet stable and may change in the future.
// GetSettingSuperIdentity Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingSuperIdentity(ctx context.Context, site string) (*SettingSuperIdentity, error) {
s, f, err := c.GetSetting(ctx, site, SettingSuperIdentityKey)
if err != nil {

View File

@@ -48,7 +48,7 @@ func (dst *SettingSuperMail) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingSuperMail Experimental! This function is not yet stable and may change in the future.
// GetSettingSuperMail Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingSuperMail(ctx context.Context, site string) (*SettingSuperMail, error) {
s, f, err := c.GetSetting(ctx, site, SettingSuperMailKey)
if err != nil {

View File

@@ -113,7 +113,7 @@ func (dst *SettingSuperMgmt) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingSuperMgmt Experimental! This function is not yet stable and may change in the future.
// GetSettingSuperMgmt Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingSuperMgmt(ctx context.Context, site string) (*SettingSuperMgmt, error) {
s, f, err := c.GetSetting(ctx, site, SettingSuperMgmtKey)
if err != nil {

View File

@@ -53,7 +53,7 @@ func (dst *SettingSuperSdn) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingSuperSdn Experimental! This function is not yet stable and may change in the future.
// GetSettingSuperSdn Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingSuperSdn(ctx context.Context, site string) (*SettingSuperSdn, error) {
s, f, err := c.GetSetting(ctx, site, SettingSuperSdnKey)
if err != nil {

View File

@@ -59,7 +59,7 @@ func (dst *SettingSuperSmtp) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingSuperSmtp Experimental! This function is not yet stable and may change in the future.
// GetSettingSuperSmtp Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingSuperSmtp(ctx context.Context, site string) (*SettingSuperSmtp, error) {
s, f, err := c.GetSetting(ctx, site, SettingSuperSmtpKey)
if err != nil {

View File

@@ -49,7 +49,7 @@ func (dst *SettingTeleport) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingTeleport Experimental! This function is not yet stable and may change in the future.
// GetSettingTeleport Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingTeleport(ctx context.Context, site string) (*SettingTeleport, error) {
s, f, err := c.GetSetting(ctx, site, SettingTeleportKey)
if err != nil {

View File

@@ -160,7 +160,7 @@ func (dst *SettingUsgDNSVerification) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingUsg Experimental! This function is not yet stable and may change in the future.
// GetSettingUsg Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingUsg(ctx context.Context, site string) (*SettingUsg, error) {
s, f, err := c.GetSetting(ctx, site, SettingUsgKey)
if err != nil {

View File

@@ -48,7 +48,7 @@ func (dst *SettingUsw) UnmarshalJSON(b []byte) error {
return nil
}
// Update SettingUsw Experimental! This function is not yet stable and may change in the future.
// GetSettingUsw Experimental! This function is not yet stable and may change in the future.
func (c *client) GetSettingUsw(ctx context.Context, site string) (*SettingUsw, error) {
s, f, err := c.GetSetting(ctx, site, SettingUswKey)
if err != nil {