clarify comments on return values of setup_*_ghost_zone()

git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinAnalysis/AHFinderDirect/trunk@283 f88db872-0e4f-0410-b76b-b9085cfa78c5

2 files changed, 11 insertions, 7 deletions

diff --git a/src/patch/patch.cc b/src/patch/patch.cc
index 0454b47..e5d9a58 100644
--- a/src/patch/patch.cc
+++ b/src/patch/patch.cc
@@ -342,7 +342,8 @@ return static_cast<interpatch_ghost_zone &>(g);
 //
 // This function assert()s that a specified ghost zone of this patch
 // hasn't already been set up, then sets it up as a mirror-symmetry
-// ghost zone.
+// ghost zone.  It returns a reference to the newly-set-up symmetry
+// ghost zone object.
 //
 symmetry_ghost_zone& patch::setup_mirror_symmetry_ghost_zone
 	(const patch_edge& my_edge)
@@ -360,7 +361,8 @@ return *temp;
 //
 // This function assert()s that a specified ghost zone of this patch
 // hasn't already been set up, then sets it up as a periodic-symmetry
-// ghost zone.
+// ghost zone.  It returns a reference to the newly-set-up symmetry
+// ghost zone object.
 //
 symmetry_ghost_zone& patch::setup_periodic_symmetry_ghost_zone
 	(const patch_edge& my_edge, const patch_edge& symmetry_edge,
@@ -389,7 +391,8 @@ return *temp;
 //
 // This function assert()s that a specified ghost zone of this patch
 // hasn't already been set up, then sets it up as an interpatch ghost
-// zone.
+// zone.  It returns a reference to the newly-set-up interpatch ghost
+// zone object.
 //
 interpatch_ghost_zone& patch::setup_interpatch_ghost_zone
 	(const patch_edge& my_edge, const patch_edge& other_edge,
@@ -427,7 +430,8 @@ my_gzp = gzp;
 
 //
 // This function assert()s that a specified frontier of this patch
-// hasn't already been set up, then sets it up.
+// hasn't already been set up, then sets it up.  It returns a reference
+// to the newly-set-up frontier object.
 //
 patch_frontier& patch::setup_patch_frontier(const patch_edge& my_edge,
 					    int min_iperp_in, int max_iperp_in,
diff --git a/src/patch/patch.hh b/src/patch/patch.hh
index f51636d..e8c3ec9 100644
--- a/src/patch/patch.hh
+++ b/src/patch/patch.hh
@@ -303,13 +303,13 @@ public:
 
 	// assert() that this ghost zone hasn't been set up yet,
 	// then set it up as mirror-symmetry
-	// ... return reference to new ghost zone
+	// ... return reference to newly-set-up ghost zone object
 	symmetry_ghost_zone& setup_mirror_symmetry_ghost_zone
 		(const patch_edge& edge);
 
 	// assert() that this ghost zone hasn't been set up yet,
 	// then set it up as periodic-symmetry
-	// ... return reference to new ghost zone
+	// ... return reference to newly-set-up ghost zone object
 	symmetry_ghost_zone& setup_periodic_symmetry_ghost_zone
 	   (const patch_edge& my_edge, const patch_edge& symmetry_edge,
 	    bool ipar_map_sign);	// one of cpm_map::{plus,minus}_map
@@ -318,7 +318,7 @@ public:
 	// then set it up as interpatch
 	// ... but don't link it to the other patch's frontier
 	//     (which doesn't exist yet)
-	// ... return reference to new ghost zone
+	// ... return reference to newly-set-up ghost zone object
 	interpatch_ghost_zone& setup_interpatch_ghost_zone
 		(const patch_edge& my_edge, const patch_edge& other_edge,
 		 int N_overlap_points);