From 8605544c0b0cbc5ad43d86a71402f3f4075b48e3 Mon Sep 17 00:00:00 2001
From: Yu Yang <yuyang18@baidu.com>
Date: Wed, 18 Jan 2017 12:49:00 +0800
Subject: [PATCH] Add some comments to compiler.h

---
 paddle/utils/Compiler.h | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/paddle/utils/Compiler.h b/paddle/utils/Compiler.h
index 22812e83987..cebca5a2a37 100644
--- a/paddle/utils/Compiler.h
+++ b/paddle/utils/Compiler.h
@@ -10,7 +10,10 @@ See the License for the specific language governing permissions and
 limitations under the License. */
 
 #pragma once
-
+/**
+ * This header defines some useful attribute by each compiler. It is the
+ * abstract layer of compilers.
+ */
 #ifdef __GNUC__
 #define GCC_VERSION \
   (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
@@ -18,6 +21,11 @@ limitations under the License. */
 #define GCC_VERSION
 #endif
 
+/**
+ * __must_check macro. It make the function's return value must be used,
+ * otherwise it will raise a compile warning. And also Paddle treat all compile
+ * warnings as errors.
+ */
 #if GCC_VERSION >= 30400
 #define __must_check __attribute__((warn_unused_result))
 #else
-- 
GitLab