From 199b5fcb45c69560de1b24b3147f5e7db309abe3 Mon Sep 17 00:00:00 2001
From: liaogang <liaogang@baidu.com>
Date: Mon, 10 Jul 2017 11:22:17 +0800
Subject: [PATCH] ENH: refine code comments

---
 paddle/memory/detail/buddy_allocator.h   |  3 ++-
 paddle/memory/detail/meta_cache.h        | 25 +++++++++---------------
 paddle/memory/detail/system_allocator.cc |  4 ++--
 paddle/memory/detail/system_allocator.h  |  6 +++---
 4 files changed, 16 insertions(+), 22 deletions(-)

diff --git a/paddle/memory/detail/buddy_allocator.h b/paddle/memory/detail/buddy_allocator.h
index eeb2dc8836..a89dd8eb7c 100644
--- a/paddle/memory/detail/buddy_allocator.h
+++ b/paddle/memory/detail/buddy_allocator.h
@@ -42,7 +42,7 @@ class BuddyAllocator {
   void Free(void*);
   size_t Used();
 
- private:
+ public:
   // Disable copy and assignment.
   BuddyAllocator(const BuddyAllocator&) = delete;
   BuddyAllocator& operator=(const BuddyAllocator&) = delete;
@@ -57,6 +57,7 @@ class BuddyAllocator {
 
   /*! \brief If existing chunks are not suitable, refill pool */
   PoolSet::iterator RefillPool();
+
   /**
    *  \brief Find the suitable chunk from existing pool
    *
diff --git a/paddle/memory/detail/meta_cache.h b/paddle/memory/detail/meta_cache.h
index 3ca1020d22..ca0789779e 100644
--- a/paddle/memory/detail/meta_cache.h
+++ b/paddle/memory/detail/meta_cache.h
@@ -23,14 +23,14 @@ namespace paddle {
 namespace memory {
 namespace detail {
 
-/*! A cache for accessing memory block meta-data that may be expensive to access
-   directly.
-
-    Note: this class exists to unify the metadata format between GPU and CPU
-   allocations.
-    It should be removed when the CPU can access all GPU allocations directly
-   via UVM.
-*/
+/**
+ *  \brief A cache for accessing memory block meta-data that may be expensive
+ *         to access directly.
+ *
+ *  \note  This class exists to unify the metadata format between GPU and CPU
+ *         allocations. It should be removed when the CPU can access all GPU
+ *         allocations directly via UVM.
+ */
 class MetadataCache {
  public:
   MetadataCache(bool uses_gpu);
@@ -42,14 +42,7 @@ class MetadataCache {
   /*! \brief Store the associated metadata for the specified memory block. */
   void store(MemoryBlock*, const Metadata&);
 
- public:
-  /*! \brief Acquire any external metadata updates. */
-  void acquire(MemoryBlock*);
-
-  /*! \brief Publish any local updates externally. */
-  void release(MemoryBlock*);
-
-  /*! \brief Indicate that the specified metadata will no longer be used */
+  /*! \brief Indicate that the specified metadata will no longer be used. */
   void invalidate(MemoryBlock*);
 
  public:
diff --git a/paddle/memory/detail/system_allocator.cc b/paddle/memory/detail/system_allocator.cc
index 75a2c91ef9..1579174b1a 100644
--- a/paddle/memory/detail/system_allocator.cc
+++ b/paddle/memory/detail/system_allocator.cc
@@ -60,7 +60,7 @@ void CPUAllocator::Free(void* p, size_t size, size_t index) {
   free(p);
 }
 
-bool CPUAllocator::UseGpu() { return false; }
+bool CPUAllocator::UseGpu() const { return false; }
 
 #ifndef PADDLE_ONLY_CPU
 
@@ -133,7 +133,7 @@ void GPUAllocator::Free(void* p, size_t size, size_t index) {
   }
 }
 
-bool GPUAllocator::UseGpu() { return true; }
+bool GPUAllocator::UseGpu() const { return true; }
 
 #endif  // PADDLE_ONLY_CPU
 
diff --git a/paddle/memory/detail/system_allocator.h b/paddle/memory/detail/system_allocator.h
index 555061a533..04efcd9709 100644
--- a/paddle/memory/detail/system_allocator.h
+++ b/paddle/memory/detail/system_allocator.h
@@ -32,14 +32,14 @@ class SystemAllocator {
   virtual ~SystemAllocator() {}
   virtual void* Alloc(size_t& index, size_t size) = 0;
   virtual void Free(void* p, size_t size, size_t index) = 0;
-  virtual bool UseGpu() = 0;
+  virtual bool UseGpu() const = 0;
 };
 
 class CPUAllocator : public SystemAllocator {
  public:
   virtual void* Alloc(size_t& index, size_t size);
   virtual void Free(void* p, size_t size, size_t index);
-  virtual bool UseGpu();
+  virtual bool UseGpu() const;
 };
 
 #ifndef PADDLE_ONLY_CPU
@@ -47,7 +47,7 @@ class GPUAllocator : public SystemAllocator {
  public:
   virtual void* Alloc(size_t& index, size_t size);
   virtual void Free(void* p, size_t size, size_t index);
-  virtual bool UseGpu();
+  virtual bool UseGpu() const;
 
  private:
   size_t gpu_alloc_size_ = 0;
-- 
GitLab