Browse Source

[2831] Rearrange sentences in API doc comment

Mukund Sivaraman 12 years ago
parent
commit
2f6c7ab36c
1 changed files with 5 additions and 6 deletions
  1. 5 6
      src/lib/util/memory_segment.h

+ 5 - 6
src/lib/util/memory_segment.h

@@ -50,14 +50,13 @@ public:
 
 /// \brief Memory Segment Class
 ///
-/// This class specifies an interface for allocating memory
-/// segments. This is an abstract class and a real
-/// implementation such as MemorySegmentLocal should be used
-/// in code.
-///
-/// It's intended to provide a unified interface whether the underlying
+/// This class specifies an interface for allocating memory segments.
+/// It's intended to provide a unified interface, whether the underlying
 /// memory is local to a specific process or is sharable by multiple
 /// processes.
+///
+/// This is an abstract class and a real implementation such as
+/// MemorySegmentLocal should be used in code.
 class MemorySegment {
 public:
     /// \brief Destructor