diff --git a/lib/bundles.cf b/lib/bundles.cf index 77b5134ca6..90b09a5dba 100644 --- a/lib/bundles.cf +++ b/lib/bundles.cf @@ -47,7 +47,7 @@ ################################################### bundle common bundles_common -# @ignore +# @brief Enumerate policy files used by this policy file for inclusion to inputs { vars: "inputs" slist => { "$(this.promise_dirname)/paths.cf", @@ -56,7 +56,7 @@ bundle common bundles_common } body file control -# @ignore +# @brief Include policy files used by this policy file as part of inputs { inputs => { @(bundles_common.inputs) }; } diff --git a/lib/cfe_internal_hub.cf b/lib/cfe_internal_hub.cf index 19bce78449..3292c9a313 100644 --- a/lib/cfe_internal_hub.cf +++ b/lib/cfe_internal_hub.cf @@ -45,7 +45,7 @@ ################################################### bundle common cfe_internal_hub_common -# @ignore +# @brief Enumerate policy files used by this policy file for inclusion to inputs { vars: "inputs" slist => { "$(this.promise_dirname)/common.cf", @@ -53,13 +53,12 @@ bundle common cfe_internal_hub_common } body file control -# @ignore +# @brief Include policy files used by this policy file as part of inputs { inputs => { @(cfe_internal_hub_common.inputs) }; } bundle agent cfe_internal_hub_maintain -# @ignore # @brief Executes reporting database maintenance process # By default database clean up interval is 24 hours. # Length of log history in database is controlled @@ -158,7 +157,6 @@ bundle agent cfe_internal_hub_maintain } bundle agent cfe_internal_database_cleanup_reports (settings) -# @ignore # @brief clean up the reporting tables { vars: @@ -186,7 +184,6 @@ AND t.$(settings[$(index)][time_key]) <= (z.latest - '$(settings[$(index)][hi } bundle agent cfe_internal_database_cleanup_consumer_status (row_count) -# @ignore # @brief keep up to row_count entries in the database # @note ENT-2797 After cf-consumer removal, this will still be necessary, functionality # of cf-consumer to be replaced with cf-hub-worker per Ole. @@ -252,8 +249,8 @@ bundle agent cfe_internal_database_cleanup_diagnostics (settings) } bundle agent cfe_internal_database_cleanup_promise_log (history_length_days) -# @ignore -# @brief clean up promise log +# @brief clean up promise log files older than `history_length_days` +# @param history_length_days Number of days after which promise logs should be deleted { vars: "cleanup_query_repaired" @@ -271,7 +268,6 @@ bundle agent cfe_internal_database_cleanup_promise_log (history_length_days) } bundle agent cfe_internal_database_partitioning() -# @ignore # @brief create any nesesary table partitions for database { vars: @@ -287,7 +283,6 @@ bundle agent cfe_internal_database_partitioning() } bundle agent cfe_internal_postgresql_maintenance -#@ignore #@brief Vacuum Full PostgreSQL for maintenance { vars: @@ -339,7 +334,6 @@ bundle agent cfe_internal_postgresql_maintenance } bundle agent cfe_internal_postgresql_vacuum -#@ignore #@brief Vacuum (with analyze) over cfdb database. { vars: diff --git a/lib/feature.cf b/lib/feature.cf index 517e768a24..cf2035bcab 100644 --- a/lib/feature.cf +++ b/lib/feature.cf @@ -79,7 +79,7 @@ bundle agent feature_test } body classes feature_cancel(x) -# @ignore +# @brief Undefine class `x` when promise is kept or repaired # Used internally by bundle `feature` { cancel_kept => { "$(x)" }; diff --git a/lib/files.cf b/lib/files.cf index eba262c68c..5ec4e1e526 100644 --- a/lib/files.cf +++ b/lib/files.cf @@ -47,14 +47,14 @@ ################################################### bundle common files_common -# @ignore +# @brief Enumerate policy files used by this policy file for inclusion to inputs { vars: "inputs" slist => { "$(this.promise_dirname)/common.cf" }; } body file control -# @ignore +# @brief Include policy files used by this policy file as part of inputs { inputs => { @(files_common.inputs) }; } @@ -873,7 +873,6 @@ bundle edit_line set_config_values_matching(v,pat) ## bundle edit_line maintain_key_values(v,sep) -# @ignore # @brief Sets the RHS of configuration items with an giving separator # # Contributed by David Lee diff --git a/lib/services.cf b/lib/services.cf index 69ecb2aee7..7c2dc4f8a3 100644 --- a/lib/services.cf +++ b/lib/services.cf @@ -47,7 +47,7 @@ ################################################### bundle common services_common -# @ignore +# @brief Enumerate policy files used by this policy file for inclusion to inputs { vars: "inputs" slist => { "$(this.promise_dirname)/common.cf", @@ -55,7 +55,7 @@ bundle common services_common } body file control -# @ignore +# @brief Include policy files used by this policy file as part of inputs { inputs => { @(services_common.inputs) }; } diff --git a/lib/vcs.cf b/lib/vcs.cf index fea4e59c72..c5eed65940 100644 --- a/lib/vcs.cf +++ b/lib/vcs.cf @@ -47,7 +47,7 @@ ################################################### bundle common vcs_common -# @ignore +# @brief Enumerate policy files used by this policy file for inclusion to inputs { vars: "inputs" slist => { "$(this.promise_dirname)/common.cf", @@ -56,7 +56,7 @@ bundle common vcs_common } body file control -# @ignore +# @brief Include policy files used by this policy file as part of inputs { inputs => { @(vcs_common.inputs) }; }