Refine code commentary

includes/civicrm-network-groups-civicrm.php

@@ -57,7 +57,12 @@ class CiviCRM_Network_Groups_CiviCRM {
 
 
 	/**
-	 * Get all Groups that are synced between CiviCRM and "Groups".
+	 * Get all CiviCRM Groups that are synced between CiviCRM and "Groups".
+	 *
+	 * Groups with sync have to be fetched from CiviCRM because "Groups" groups
+	 * have no mechanism for storing metadata. "CiviCRM Groups Sync" stores the
+	 * synced group metadata in the "source" field with a (hopefully) unique
+	 * prefix: "synced-group-" followed by the numeric ID of the "Groups" group.
 	 *
 	 * @since 0.1
 	 *
@@ -116,7 +121,7 @@ class CiviCRM_Network_Groups_CiviCRM {
 
 
 	/**
-	 * Get the Groups for a given CiviCRM contact ID.
+	 * Get the CiviCRM Groups for a given CiviCRM contact ID.
 	 *
 	 * @since 0.1
 	 *
@@ -161,7 +166,7 @@ class CiviCRM_Network_Groups_CiviCRM {
 
 
 	/**
-	 * Get the Group IDs for a given CiviCRM contact ID.
+	 * Get the CiviCRM Group IDs for a given CiviCRM contact ID.
 	 *
 	 * @since 0.1
 	 *
@@ -240,7 +245,7 @@ class CiviCRM_Network_Groups_CiviCRM {
 
 
 	/**
-	 * Delete a CiviCRM contact from a CiviCRM group.
+	 * Remove a CiviCRM contact from a CiviCRM group.
 	 *
 	 * @since 0.1
 	 *

includes/civicrm-network-groups-wordpress.php

@@ -58,7 +58,7 @@ class CiviCRM_Network_Groups_WordPress {
 
 
 	/**
-	 * Add National Groups UI on User Edit screen.
+	 * Add Network Groups UI on "Edit User" screen.
 	 *
 	 * @since 0.1
 	 *
@@ -123,7 +123,7 @@ class CiviCRM_Network_Groups_WordPress {
 
 
 	/**
-	 * Save data when form is submitted on user's own User Edit screen.
+	 * Save data when form is submitted on user's own "Edit User" screen.
 	 *
 	 * @since 0.1
 	 *
@@ -139,7 +139,7 @@ class CiviCRM_Network_Groups_WordPress {
 
 
 	/**
-	 * Save data when form is submitted on another user's User Edit screen.
+	 * Save data when form is submitted on another user's "Edit User" screen.
 	 *
 	 * @since 0.1
 	 *