Merge pull request #1794 from nickanderson/CFE-3378/master

CFE-3378/master: Replaced @ignore with useful doc strings

Author: nickanderson

lib/bundles.cf

@@ -1,7 +1,7 @@
 # Bundles
 
 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",
@@ -10,7 +10,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) };
 }

lib/cfe_internal_hub.cf

@@ -1,19 +1,18 @@
 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",
                           "$(this.promise_dirname)/commands.cf"};
 }
 
 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
@@ -112,7 +111,6 @@ bundle agent cfe_internal_hub_maintain
 }
 
 bundle agent cfe_internal_database_cleanup_reports (settings)
-# @ignore
 # @brief clean up the reporting tables
 {
   vars:
@@ -140,7 +138,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.
@@ -206,8 +203,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"
@@ -225,7 +222,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:
@@ -241,7 +237,6 @@ bundle agent cfe_internal_database_partitioning()
 }
 
 bundle agent cfe_internal_postgresql_maintenance
-#@ignore
 #@brief Vacuum Full PostgreSQL for maintenance
 {
   vars:
@@ -293,7 +288,6 @@ bundle agent cfe_internal_postgresql_maintenance
 }
 
 bundle agent cfe_internal_postgresql_vacuum
-#@ignore
 #@brief Vacuum (with analyze) over cfdb database.
 {
   vars:

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)" };

lib/files.cf

@@ -1,14 +1,14 @@
 # Files bodies
 
 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) };
 }
@@ -827,7 +827,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

lib/services.cf

@@ -1,15 +1,15 @@
 # Services bodies
 
 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",
                           "$(this.promise_dirname)/paths.cf" };
 }
 
 body file control
-# @ignore
+# @brief Include policy files used by this policy file as part of inputs
 {
       inputs => { @(services_common.inputs) };
 }

lib/vcs.cf

@@ -1,7 +1,7 @@
 # VCS Bundles
 
 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",
@@ -10,7 +10,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) };
 }