Move comments next to the function prototypes they describe.

No functional change.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@14885 a5019735-40e9-0310-863c-91ae7b9d1cf9

2 files changed, 19 insertions, 30 deletions

diff --git a/coregrind/pub_core_aspacemgr.h b/coregrind/pub_core_aspacemgr.h
index 0e4e26991..aec6add1b 100644
--- a/coregrind/pub_core_aspacemgr.h
+++ b/coregrind/pub_core_aspacemgr.h
@@ -65,30 +65,18 @@ extern Addr VG_(am_startup) ( Addr sp_at_startup );
 //--------------------------------------------------------------
 // Querying current status
 
-/* Finds the segment containing 'a'.  Only returns file/anon/resvn
-   segments.  This returns a 'NSegment const *' - a pointer to
-   readonly data. */
-// Is in tool-visible header file.
-// extern NSegment const * VG_(am_find_nsegment) ( Addr a );
 
 /* Find the next segment along from 'here', if it is a file/anon/resvn
    segment. */
 extern NSegment const* VG_(am_next_nsegment) ( const NSegment* here,
                                                Bool fwds );
 
-/* Is the area [start .. start+len-1] validly accessible by the 
-   client with at least the permissions 'prot' ?  To find out
-   simply if said area merely belongs to the client, pass 
+/* Is the area [start .. start+len-1] validly accessible by
+   valgrind with at least the permissions 'prot' ?  To find out
+   simply if said area merely belongs to valgrind, pass 
    VKI_PROT_NONE as 'prot'.  Will return False if any part of the
-   area does not belong to the client or does not have at least
+   area does not belong to valgrind or does not have at least
    the stated permissions. */
-// Is in tool-visible header file.
-// extern Bool VG_(am_is_valid_for_client)
-//   ( Addr start, SizeT len, UInt prot );
-
-/* Same as VG_(am_is_valid_for_client) but for valgrind :
-   test if memory is addressable by valgrind with at least
-   the protection 'prot'. */
 extern Bool VG_(am_is_valid_for_valgrind)
    ( Addr start, SizeT len, UInt prot );
 
@@ -107,15 +95,6 @@ extern ULong VG_(am_get_anonsize_total)( void );
 /* Show the segment array on the debug log, at given loglevel. */
 extern void VG_(am_show_nsegments) ( Int logLevel, const HChar* who );
 
-/* Get the filename corresponding to this segment, if known and if it
-   has one.  The returned name's storage cannot be assumed to be
-   persistent, so the caller should immediately copy the name
-   elsewhere.  This may return NULL if the file name is not known or
-   for arbitrary other implementation-dependent reasons, so callers
-   need to be able to handle a NULL return value. */
-// Is in tool-visible header file.
-// extern HChar* VG_(am_get_filename)( NSegment* );
-
 /* VG_(am_get_segment_starts) is also part of this section, but its
    prototype is tool-visible, hence not in this header file. */
 
diff --git a/include/pub_tool_aspacemgr.h b/include/pub_tool_aspacemgr.h
index d10961893..05cc1d344 100644
--- a/include/pub_tool_aspacemgr.h
+++ b/include/pub_tool_aspacemgr.h
@@ -133,18 +133,28 @@ typedef
    order to establish a suitably-sized buffer. */
 extern Int VG_(am_get_segment_starts)( Addr* starts, Int nStarts );
 
-
-// See pub_core_aspacemgr.h for description.
+/* Finds the segment containing 'a'.  Only returns file/anon/resvn
+   segments.  This returns a 'NSegment const *' - a pointer to
+   readonly data. */
 extern NSegment const * VG_(am_find_nsegment) ( Addr a ); 
 
-// See pub_core_aspacemgr.h for description.
+/* Get the filename corresponding to this segment, if known and if it
+   has one.  The returned name's storage cannot be assumed to be
+   persistent, so the caller should immediately copy the name
+   elsewhere.  This may return NULL if the file name is not known or
+   for arbitrary other implementation-dependent reasons, so callers
+   need to be able to handle a NULL return value. */
 extern HChar* VG_(am_get_filename)( NSegment const * );
 
-// See pub_core_aspacemgr.h for description.
+/* Is the area [start .. start+len-1] validly accessible by the 
+   client with at least the permissions 'prot' ?  To find out
+   simply if said area merely belongs to the client, pass 
+   VKI_PROT_NONE as 'prot'.  Will return False if any part of the
+   area does not belong to the client or does not have at least
+   the stated permissions. */
 extern Bool VG_(am_is_valid_for_client) ( Addr start, SizeT len, 
                                           UInt prot );
 
-// See pub_core_aspacemgr.h for description.
 /* Really just a wrapper around VG_(am_mmap_anon_float_valgrind). */
 extern void* VG_(am_shadow_alloc)(SizeT size);