QA: Remove old stub function name documentation

aggregate_graphs.php

@@ -379,11 +379,11 @@ function form_save() {
 	}
 }
 
-/* -----------------------
-	save aggregate graph item
-	This saves any overrides to item properties from graph template item.
-	Inserting new items here is not possible. Just editing existing ones.
-   ----------------------- */
+/**
+ * form_save_aggregate - save aggregate graph item
+ *   This saves any overrides to item properties from graph template item.
+ *   Inserting new items here is not possible. Just editing existing ones.
+ */
 function form_save_aggregate() {
 	global $config;
 
@@ -1055,12 +1055,9 @@ function item() {
 	html_end_box(false);
 }
 
-/* ------------------------------------
-	graph - Graphs
-   ------------------------------------ */
-
 function graph_edit() {
-	global $config, $struct_graph, $struct_aggregate_graph, $image_types, $consolidation_functions, $graph_item_types, $struct_graph_item;
+	global $config, $struct_graph, $struct_aggregate_graph, $image_types;
+	global $consolidation_functions, $graph_item_types, $struct_graph_item;
 
 	// Remove filter item
 	unset($struct_graph_item['data_template_id']);

aggregate_templates.php

@@ -63,9 +63,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* --------------------------
-	The Save Function
-   -------------------------- */
 /**
  * aggregate_form_save	the save function
  */
@@ -282,11 +279,8 @@ function aggregate_form_save() {
 function aggregate_get_graph_items($table, $id) {
 }
 
-/* ------------------------
-	The 'actions' function
-   ------------------------ */
 /**
- * aggregate_form_actions		the action function
+ * aggregate_form_actions - the action function
  */
 function aggregate_form_actions() {
 	global $aggregate_actions, $config;

auth_profile.php

@@ -135,10 +135,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* --------------------------
-	The Save Function
-   -------------------------- */
-
 function api_auth_logout_everywhere() {
 	$user = $_SESSION[SESS_USER_ID];
 
@@ -293,10 +289,6 @@ function form_save() {
 	header('Location: auth_profile.php' . $tab);
 }
 
-/* --------------------------
-	User Settings Functions
-   -------------------------- */
-
 function settings() {
 	global $tabs_graphs, $settings_user, $current_user, $graph_views, $current_user;
 

changelog.php

@@ -44,10 +44,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* -----------------------
-	Functions
-   ----------------------- */
-
 function changelog_view() {
 	global $database_default, $config, $rrdtool_versions, $poller_options, $input_types, $local_db_cnn_id;
 

data_input.php

@@ -290,10 +290,6 @@ function form_actions() {
 	bottom_footer();
 }
 
-/* --------------------------
-	CDEF Item Functions
-   -------------------------- */
-
 function field_remove_confirm() {
 	/* ================= input validation ================= */
 	get_filter_request_var('id');
@@ -493,10 +489,6 @@ function field_edit() {
 	form_save_button('data_input.php?action=edit&id=' . get_request_var('data_input_id'));
 }
 
-/* -----------------------
-	Data Input Functions
-   ----------------------- */
-
 function data_edit() {
 	global $config, $fields_data_input_edit;
 

data_queries.php

@@ -123,10 +123,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* --------------------------
-	The Save Function
-   -------------------------- */
-
 function form_save() {
 	if (isset_request_var('save_component_snmp_query')) {
 		get_filter_request_var('id');
@@ -436,10 +432,6 @@ function form_actions() {
 	bottom_footer();
 }
 
-/* ----------------------------
-	Data Query Graph Functions
-   ---------------------------- */
-
 function data_query_item_movedown_gsv() {
 	/* ================= input validation ================= */
 	get_filter_request_var('id');
@@ -1066,10 +1058,6 @@ function data_query_item_edit() {
 	form_save_button('data_queries.php?action=edit&id=' . get_request_var('snmp_query_id'), 'return');
 }
 
-/* ---------------------
-	Data Query Functions
-   --------------------- */
-
 function data_query_remove($id) {
 	$snmp_query_graph = db_fetch_assoc_prepared('SELECT id
 		FROM snmp_query_graph

data_sources.php

@@ -122,10 +122,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* --------------------------
-	The Save Function
-   -------------------------- */
-
 function form_save() {
 	if ((isset_request_var('save_component_data_source_new')) && (!isempty_request_var('data_template_id'))) {
 		$save['id']               = get_filter_request_var('local_data_id');
@@ -369,10 +365,6 @@ function form_save() {
 	}
 }
 
-/* ------------------------
-	The "actions" function
-   ------------------------ */
-
 function form_actions() {
 	global $ds_actions;
 
@@ -615,10 +607,6 @@ function form_actions() {
 	bottom_footer();
 }
 
-/* ----------------------------
-	data - Custom Data
-   ---------------------------- */
-
 function data_edit($incform = true) {
 	/* ================= input validation ================= */
 	get_filter_request_var('id');
@@ -730,10 +718,6 @@ function data_edit($incform = true) {
 	form_hidden_box('save_component_data', '1', '');
 }
 
-/* ------------------------
-	Data Source Functions
-   ------------------------ */
-
 function ds_rrd_remove() {
 	/* ================= input validation ================= */
 	get_filter_request_var('id');

data_templates.php

@@ -81,10 +81,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* --------------------------
-	The Save Function
-   -------------------------- */
-
 function form_save() {
 	if (isset_request_var('save_component_template')) {
 		/* ================= input validation ================= */
@@ -356,10 +352,6 @@ function form_save() {
 	}
 }
 
-/* ------------------------
-	The "actions" function
-   ------------------------ */
-
 function form_actions() {
 	global $ds_actions;
 
@@ -526,10 +518,6 @@ function form_actions() {
 	bottom_footer();
 }
 
-/* ----------------------------
-	template - Data Templates
-   ---------------------------- */
-
 function template_rrd_remove() {
 	/* ================= input validation ================= */
 	get_filter_request_var('id');

graph_templates.php

@@ -935,11 +935,8 @@ function item_edit() {
 			changeColorId();
 		}
 	</script>
-<?php
+	<?php
 }
-/* ------------------------
-	The 'actions' function
-   ------------------------ */
 
 function form_actions() {
 	global $graph_actions, $config, $image_types;
@@ -1268,10 +1265,6 @@ function item() {
 	html_end_box();
 }
 
-/* ----------------------------
-	template - Graph Templates
-   ---------------------------- */
-
 function template_edit() {
 	global $struct_graph, $image_types, $fields_graph_template_template_edit;
 

graphs.php

@@ -175,10 +175,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* --------------------------
-	Global Form Functions
-   -------------------------- */
-
 function get_ajax_graph_items() {
 	$rrd_id  = get_filter_request_var('rrd_id');
 	$host_id = get_filter_request_var('host_id');
@@ -248,10 +244,6 @@ function add_tree_names_to_actions_array() {
 	}
 }
 
-/* --------------------------
-	The Save Function
-   -------------------------- */
-
 function parse_validate_graph_template_id($variable) {
 	$output_type_id = 0;
 
@@ -1077,10 +1069,6 @@ function item_edit() {
 <?php
 }
 
-/* ------------------------
-	The "actions" function
-   ------------------------ */
-
 function get_current_graph_template($local_graph_id) {
 	$graph_local = db_fetch_row_prepared('SELECT *
 		FROM graph_local
@@ -1989,10 +1977,6 @@ function form_actions() {
 	bottom_footer();
 }
 
-/* -----------------------
-	item - Graph Items
-   ----------------------- */
-
 function item() {
 	global $consolidation_functions, $graph_item_types, $struct_graph_item;
 
@@ -2066,10 +2050,6 @@ function item() {
 	html_end_box();
 }
 
-/* ------------------------------------
-	graph - Graphs
-   ------------------------------------ */
-
 function is_multi_device_graph($local_graph_id) {
 	$devices = db_fetch_cell_prepared('SELECT COUNT(DISTINCT host_id)
 		FROM data_template_rrd AS dtr

graphs_new.php

@@ -74,10 +74,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* --------------------------
-	The Save Function
-   -------------------------- */
-
 function save_default_query_option() {
 	$data_query = get_filter_request_var('query');
 	$default    = get_filter_request_var('item');
@@ -183,10 +179,6 @@ function form_save() {
 	}
 }
 
-/* -------------------
-	Data Query Functions
-   ------------------- */
-
 function host_reload_query() {
 	/* ================= input validation ================= */
 	get_filter_request_var('id');
@@ -196,10 +188,6 @@ function host_reload_query() {
 	run_data_query(get_request_var('host_id'), get_request_var('id'));
 }
 
-/* -------------------
-	New Graph Functions
-   ------------------- */
-
 function host_new_graphs_save($host_id) {
 	$selected_graphs_array = cacti_unserialize(stripslashes(get_nfilter_request_var('selected_graphs_array')));
 
@@ -300,10 +288,6 @@ function host_new_graphs_save($host_id) {
 	}
 }
 
-/* -------------------
-	Graph Functions
-   ------------------- */
-
 function graphs() {
 	global $config, $item_rows;
 

host.php

@@ -183,10 +183,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* --------------------------
-	Global Form Functions
-   -------------------------- */
-
 function host_reindex() {
 	global $config;
 
@@ -260,10 +256,6 @@ function get_site_locations() {
 	print json_encode($return);
 }
 
-/* --------------------------
-	The Save Function
-   -------------------------- */
-
 function form_save() {
 	if (isset_request_var('save_component_host')) {
 		if (get_nfilter_request_var('snmp_version') == 3 && (get_nfilter_request_var('snmp_password') != get_nfilter_request_var('snmp_password_confirm'))) {
@@ -315,10 +307,6 @@ function form_save() {
 	}
 }
 
-/* ------------------------
-	The "actions" function
-   ------------------------ */
-
 function form_actions() {
 	global $device_actions, $device_change_fields, $fields_host_edit;
 
@@ -610,10 +598,6 @@ function form_actions() {
 	bottom_footer();
 }
 
-/* -------------------
-	Device Export Function
-   ------------------- */
-
 function host_export() {
 	host_validate_vars();
 
@@ -636,10 +620,6 @@ function host_export() {
 	fclose($stdout);
 }
 
-/* -------------------
-	Data Query Functions
-   ------------------- */
-
 function host_add_query() {
 	/* ================= input validation ================= */
 	get_filter_request_var('host_id');
@@ -714,10 +694,6 @@ function host_remove_gt() {
 	api_device_gt_remove(get_request_var('host_id'), get_request_var('id'));
 }
 
-/* ---------------------
-	Device Functions
-   --------------------- */
-
 function host_edit() {
 	global $fields_host_edit, $reindex_types;
 

host_templates.php

@@ -102,10 +102,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* --------------------------
-	The Save Function
-   -------------------------- */
-
 function form_save() {
 	/* ================= input validation ================= */
 	get_filter_request_var('id');
@@ -134,10 +130,6 @@ function form_save() {
 	}
 }
 
-/* ------------------------
-	The "actions" function
-   ------------------------ */
-
 function template_item_add_dq() {
 	/* ================= input validation ================= */
 	get_filter_request_var('host_template_id');
@@ -288,10 +280,6 @@ function form_actions() {
 	bottom_footer();
 }
 
-/* ---------------------
-	Template Functions
-   --------------------- */
-
 function template_item_remove_gt_confirm() {
 	/* ================= input validation ================= */
 	get_filter_request_var('id');

pollers.php

@@ -238,7 +238,7 @@ $fields_poller_edit = array(
 		'description'   => __("Provides a way to disable verification of the server's SSL certificate Common Name against the server's hostname when connecting. This verification is enabled by default."),
 		'value'         => '|arg1:dbsslverifyservercert|',
 		'default'       => $database_ssl_verify_server_cert ? 'on' : ''
-	),        
+	),
 	'id' => array(
 		'method' => 'hidden',
 		'value'  => '|arg1:id|',
@@ -295,14 +295,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* --------------------------
-	Global Form Functions
-   -------------------------- */
-
-/* --------------------------
-	The Save Function
-   -------------------------- */
-
 function form_save() {
 	if (isset_request_var('save_component_poller')) {
 		// Common data
@@ -677,10 +669,6 @@ function form_actions() {
 	bottom_footer();
 }
 
-/* ---------------------
-	Site Functions
-   --------------------- */
-
 function poller_edit() {
 	global $fields_poller_edit;
 

support.php

@@ -35,10 +35,6 @@ set_default_action();
 
 support_view_tech();
 
-/* -----------------------
-	Functions
-   ----------------------- */
-
 function support_view_tech() {
 	global $config, $database_hostname, $poller_options, $input_types, $local_db_cnn_id;
 

templates_export.php

@@ -44,10 +44,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* --------------------------
-	The Save Function
-   -------------------------- */
-
 function form_save() {
 	global $export_types, $export_errors;
 
@@ -84,10 +80,6 @@ function form_save() {
 	}
 }
 
-/* ---------------------------
-	Template Export Functions
-   --------------------------- */
-
 function export() {
 	global $export_types;
 

templates_import.php

@@ -53,10 +53,6 @@ if ($is_tmp && $is_save && $action == 'save') {
 	bottom_footer();
 }
 
-/* --------------------------
-	The Save Function
-   -------------------------- */
-
 function form_save() {
 	global $preview_only, $messages, $import_messages;
 

tree.php

@@ -524,9 +524,6 @@ function set_branch_sort_type() {
 	}
 }
 
-/* --------------------------
-	The Save Function
-   -------------------------- */
 function form_save() {
 	/* clear graph tree cache on save - affects current user only, other users should see changes in <5 minutes */
 	if (isset($_SESSION['dhtml_tree'])) {
@@ -635,9 +632,6 @@ function leaves_exist($parent, $tree_id) {
 		array($tree_id, $parent));
 }
 
-/* -----------------------
-	Tree Item Functions
-   ----------------------- */
 function form_actions() {
 	global $tree_actions;
 
@@ -785,10 +779,6 @@ function form_actions() {
 	bottom_footer();
 }
 
-/* ---------------------
-	Tree Functions
-   --------------------- */
-
 function tree_edit($partial = false) {
 	global $fields_tree_edit;
 

user_admin.php

@@ -78,10 +78,6 @@ if (isset_request_var('update_policy')) {
 	}
 }
 
-/* --------------------------
-	Actions Function
-   -------------------------- */
-
 function update_policies() {
 	$policies = array('policy_graphs', 'policy_trees', 'policy_hosts', 'policy_graph_templates');
 
@@ -430,10 +426,6 @@ function form_actions() {
 	}
 }
 
-/* --------------------------
-	Save Function
-   -------------------------- */
-
 function form_save() {
 	global $settings_user;
 
@@ -1772,10 +1764,6 @@ function settings_edit($header_label) {
 	<?php
 }
 
-/* --------------------------
-	User Administration
-   -------------------------- */
-
 function user_edit() {
 	global $config, $fields_user_user_edit_host;
 

user_domains.php

@@ -64,10 +64,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* --------------------------
-	The Save Function
-   -------------------------- */
-
 function form_save() {
 	global $registered_cacti_names;
 
@@ -257,10 +253,6 @@ function form_actions() {
 	}
 }
 
-/* -----------------------
-	Domain Functions
-   ----------------------- */
-
 function domain_remove($domain_id) {
 	db_execute_prepared('DELETE FROM user_domains WHERE domain_id = ?', array($domain_id));
 	db_execute_prepared('DELETE FROM user_domains_ldap WHERE domain_id = ?', array($domain_id));

user_group_admin.php

@@ -178,10 +178,6 @@ if (isset_request_var('update_policy')) {
 	}
 }
 
-/* --------------------------
-	Actions Function
-   -------------------------- */
-
 function user_group_disable($id) {
 	db_execute_prepared("UPDATE user_auth_group SET enabled = '' WHERE id = ?", array($id));
 
@@ -494,10 +490,6 @@ function form_actions() {
 	}
 }
 
-/* --------------------------
-	Save Function
-   -------------------------- */
-
 function form_save() {
 	global $settings_user;
 
@@ -590,10 +582,6 @@ function form_save() {
 	header('Location: user_group_admin.php?action=edit&tab=general&id=' .  get_nfilter_request_var('id'));
 }
 
-/* --------------------------
-	Graph Permissions
-   -------------------------- */
-
 function perm_remove() {
 	/* ================= input validation ================= */
 	get_filter_request_var('id');
@@ -1663,10 +1651,6 @@ function user_group_settings_edit($header_label) {
 	<?php
 }
 
-/* --------------------------
-	User Administration
-   -------------------------- */
-
 function group_edit() {
 	global $config, $fields_user_group_edit;
 

user_log.php

@@ -53,10 +53,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* -----------------------
-	Functions
-   ----------------------- */
-
 function view_user_log() {
 	global $auth_realms, $item_rows;
 

utilities.php

@@ -143,10 +143,6 @@ switch (get_request_var('action')) {
 		break;
 }
 
-/* -----------------------
-	Utilities Functions
-   ----------------------- */
-
 function rebuild_resource_cache() {
 	db_execute('DELETE FROM settings WHERE name LIKE "md5dirsum%"');
 	db_execute('TRUNCATE TABLE poller_resource_cache');