ignite-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From anovi...@apache.org
Subject [07/10] ignite git commit: IGNITE-2164: CPP: Added namespace description. Docs fixes.
Date Wed, 16 Dec 2015 10:28:47 GMT
IGNITE-2164: CPP: Added namespace description. Docs fixes.


Project: http://git-wip-us.apache.org/repos/asf/ignite/repo
Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/77c6d08a
Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/77c6d08a
Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/77c6d08a

Branch: refs/heads/ignite-843-rc2
Commit: 77c6d08a41d349aea850b6c6ca4190b8ec77e22a
Parents: 65b1766
Author: isapego <isapego@gridgain.com>
Authored: Wed Dec 16 11:36:40 2015 +0300
Committer: vozerov-gridgain <vozerov@gridgain.com>
Committed: Wed Dec 16 11:36:40 2015 +0300

----------------------------------------------------------------------
 .../common/include/ignite/common/concurrent.h   |  2 +-
 .../cpp/common/include/ignite/common/utils.h    |  1 -
 modules/platforms/cpp/common/src/java.cpp       | 20 ++++----
 modules/platforms/cpp/core/impl/doxygen.h       | 53 ++++++++++++++++++++
 .../core/include/ignite/binary/binary_type.h    |  4 +-
 .../cpp/core/include/ignite/cache/cache.h       | 12 ++---
 .../include/ignite/cache/query/query_scan.h     | 28 +++++------
 .../include/ignite/cache/query/query_text.h     | 38 +++++++-------
 .../cpp/core/include/ignite/ignition.h          | 10 +---
 .../core/include/ignite/impl/cache/cache_impl.h |  6 +--
 .../cpp/core/include/ignite/impl/operations.h   |  8 +--
 modules/platforms/cpp/cpp.dxg                   |  4 +-
 12 files changed, 115 insertions(+), 71 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/ignite/blob/77c6d08a/modules/platforms/cpp/common/include/ignite/common/concurrent.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/common/include/ignite/common/concurrent.h b/modules/platforms/cpp/common/include/ignite/common/concurrent.h
index fbba808..a4cc3f7 100644
--- a/modules/platforms/cpp/common/include/ignite/common/concurrent.h
+++ b/modules/platforms/cpp/common/include/ignite/common/concurrent.h
@@ -214,7 +214,7 @@ namespace ignite
                     return impl ? static_cast<T*>(impl->Pointer()) : NULL;
                 }
 
-                /*
+                /**
                  * Check whether underlying raw pointer is valid.
                  *
                  * @return True if valid.

http://git-wip-us.apache.org/repos/asf/ignite/blob/77c6d08a/modules/platforms/cpp/common/include/ignite/common/utils.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/common/include/ignite/common/utils.h b/modules/platforms/cpp/common/include/ignite/common/utils.h
index 4b590d9..44db6e8 100644
--- a/modules/platforms/cpp/common/include/ignite/common/utils.h
+++ b/modules/platforms/cpp/common/include/ignite/common/utils.h
@@ -1,4 +1,3 @@
-#pragma once
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with

http://git-wip-us.apache.org/repos/asf/ignite/blob/77c6d08a/modules/platforms/cpp/common/src/java.cpp
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/common/src/java.cpp b/modules/platforms/cpp/common/src/java.cpp
index 7bc18f1..64f5d9c 100644
--- a/modules/platforms/cpp/common/src/java.cpp
+++ b/modules/platforms/cpp/common/src/java.cpp
@@ -78,7 +78,7 @@ namespace ignite
                 }
             };
 
-            /*
+            /**
              * Heloper function to copy characters.
              *
              * @param src Source.
@@ -148,7 +148,7 @@ namespace ignite
                     delete[] errMsg;
             }
 
-            /*
+            /**
              * Guard to ensure global reference cleanup.
              */
             class JniGlobalRefGuard
@@ -397,7 +397,7 @@ namespace ignite
 
             /* HELPER METHODS. */
 
-            /*
+            /**
              * Throw exception to Java in case of missing callback pointer. It means that
callback is not implemented in
              * native platform and Java -> platform operation cannot proceede further.
As JniContext is not available at
              * this point, we have to obtain exception details from scratch. This is not
critical from performance
@@ -728,7 +728,7 @@ namespace ignite
                 return members;
             }
 
-            /*
+            /**
              * Create JVM.
              */
             void CreateJvm(char** opts, int optsLen, JavaVM** jvm, JNIEnv** env) {
@@ -2084,9 +2084,9 @@ namespace ignite
                 jvm->GetJvm()->DestroyJavaVM();
             }
 
-            /*
-            * Attach thread to JVM.
-            */
+            /**
+             * Attach thread to JVM.
+             */
             JNIEnv* JniContext::Attach() {
                 JNIEnv* env;
 
@@ -2164,9 +2164,9 @@ namespace ignite
                 }
             }
 
-            /*
-            * Convert local reference to global.
-            */
+            /**
+             * Convert local reference to global.
+             */
             jobject JniContext::LocalToGlobal(JNIEnv* env, jobject localRef) {
                 if (localRef) {
                     jobject globalRef = env->NewGlobalRef(localRef);

http://git-wip-us.apache.org/repos/asf/ignite/blob/77c6d08a/modules/platforms/cpp/core/impl/doxygen.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/impl/doxygen.h b/modules/platforms/cpp/core/impl/doxygen.h
new file mode 100644
index 0000000..ed237f6
--- /dev/null
+++ b/modules/platforms/cpp/core/impl/doxygen.h
@@ -0,0 +1,53 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * \mainpage Apache Ignite C++
+ *
+ * Apache Ignite In-Memory Data Fabric is a high-performance, integrated and distributed
in-memory platform for
+ * computing and transacting on large-scale data sets in real-time, orders of magnitude faster
than possible with
+ * traditional disk-based or flash-based technologies.
+ */
+ 
+ /**
+  * Apache %Ignite API.
+  */
+ namespace ignite
+ {
+	 /**
+	  * %Ignite Binary Objects API.
+	  */
+	 namespace binary
+	 {
+		 // Empty.
+	 }
+	 
+	 /**
+	  * %Ignite %Cache API.
+	  */
+	 namespace cache
+	 {
+		 /**
+		  * Contains APIs for creating and executing cache queries.
+		  */
+		 namespace query
+		 {
+			 // Empty.
+		 }
+	 }
+ }
+ 
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/ignite/blob/77c6d08a/modules/platforms/cpp/core/include/ignite/binary/binary_type.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/binary/binary_type.h b/modules/platforms/cpp/core/include/ignite/binary/binary_type.h
index 576a4d6..353b3bb 100644
--- a/modules/platforms/cpp/core/include/ignite/binary/binary_type.h
+++ b/modules/platforms/cpp/core/include/ignite/binary/binary_type.h
@@ -226,8 +226,8 @@ namespace ignite
             }
         };
 
-        /*
-         * Templated binary type for pointers.
+        /**
+         * Templated binary type specification for pointers.
          */
         template <typename T>
         struct IGNITE_IMPORT_EXPORT BinaryType<T*>

http://git-wip-us.apache.org/repos/asf/ignite/blob/77c6d08a/modules/platforms/cpp/core/include/ignite/cache/cache.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/cache/cache.h b/modules/platforms/cpp/core/include/ignite/cache/cache.h
index 7581d86..ad23d62 100644
--- a/modules/platforms/cpp/core/include/ignite/cache/cache.h
+++ b/modules/platforms/cpp/core/include/ignite/cache/cache.h
@@ -1083,7 +1083,7 @@ namespace ignite
                 return query::QueryCursor<K, V>(cursorImpl);
             }
 
-            /*
+            /**
              * Perform text query.
              *
              * @param qry Query.
@@ -1100,7 +1100,7 @@ namespace ignite
                 return res;
             }
 
-            /*
+            /**
              * Perform text query.
              *
              * @param qry Query.
@@ -1114,7 +1114,7 @@ namespace ignite
                 return query::QueryCursor<K, V>(cursorImpl);
             }
 
-            /*
+            /**
              * Perform scan query.
              *
              * @param qry Query.
@@ -1131,7 +1131,7 @@ namespace ignite
                 return res;
             }
 
-            /*
+            /**
              * Perform scan query.
              *
              * @param qry Query.
@@ -1145,7 +1145,7 @@ namespace ignite
                 return query::QueryCursor<K, V>(cursorImpl);
             }
 
-            /*
+            /**
              * Perform sql fields query.
              *
              * @param qry Query.
@@ -1162,7 +1162,7 @@ namespace ignite
                 return res;
             }
 
-            /*
+            /**
              * Perform sql fields query.
              *
              * @param qry Query.

http://git-wip-us.apache.org/repos/asf/ignite/blob/77c6d08a/modules/platforms/cpp/core/include/ignite/cache/query/query_scan.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/cache/query/query_scan.h b/modules/platforms/cpp/core/include/ignite/cache/query/query_scan.h
index c8389b2..fa47269 100644
--- a/modules/platforms/cpp/core/include/ignite/cache/query/query_scan.h
+++ b/modules/platforms/cpp/core/include/ignite/cache/query/query_scan.h
@@ -29,13 +29,13 @@ namespace ignite
     {
         namespace query
         {         
-            /*
-             * Scab query.
+            /**
+             * Scan query.
              */
             class ScanQuery
             {
             public:
-                /* 
+                /**
                  * Constructor.
                  */
                 ScanQuery() : part(-1), pageSize(1024), loc(false)
@@ -43,7 +43,7 @@ namespace ignite
                     // No-op.
                 }
                 
-                /*
+                /**
                  * Constructor.
                  *
                  * @param part Partition.
@@ -53,7 +53,7 @@ namespace ignite
                     // No-op.
                 }
                 
-                /*
+                /**
                  * Get partition to scan.
                  *
                  * @return Partition to scan.
@@ -63,7 +63,7 @@ namespace ignite
                     return part;
                 }
 
-                /*
+                /**
                  * Set partition to scan.
                  *
                  * @param part Partition to scan.
@@ -73,7 +73,7 @@ namespace ignite
                     this->part = part;
                 }
 
-                /*
+                /**
                  * Get page size.
                  *
                  * @return Page size.
@@ -83,7 +83,7 @@ namespace ignite
                     return pageSize;
                 }
 
-                /*
+                /**
                  * Set page size.
                  *
                  * @param pageSize Page size.
@@ -93,7 +93,7 @@ namespace ignite
                     this->pageSize = pageSize;
                 }
 
-                /*
+                /**
                  * Get local flag.
                  *
                  * @return Local flag.
@@ -103,7 +103,7 @@ namespace ignite
                     return loc;
                 }
 
-                /*
+                /**
                  * Set local flag.
                  *
                  * @param loc Local flag.
@@ -113,7 +113,7 @@ namespace ignite
                     this->loc = loc;
                 }
                 
-                /*
+                /**
                  * Write query info to the stream.
                  *
                  * @param writer Writer.
@@ -135,13 +135,13 @@ namespace ignite
                 }
 
             private:
-                /* Partition. */
+                /** Partition. */
                 int32_t part;
 
-                /* Page size. */
+                /** Page size. */
                 int32_t pageSize;
 
-                /* Local flag. */
+                /** Local flag. */
                 bool loc;
             };
         }

http://git-wip-us.apache.org/repos/asf/ignite/blob/77c6d08a/modules/platforms/cpp/core/include/ignite/cache/query/query_text.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/cache/query/query_text.h b/modules/platforms/cpp/core/include/ignite/cache/query/query_text.h
index f4e7f99..4494883 100644
--- a/modules/platforms/cpp/core/include/ignite/cache/query/query_text.h
+++ b/modules/platforms/cpp/core/include/ignite/cache/query/query_text.h
@@ -29,13 +29,13 @@ namespace ignite
     {
         namespace query
         {         
-            /*
+            /**
              * Text query.
              */
             class TextQuery
             {
             public:
-                /*
+                /**
                  * Constructor.
                  *
                  * @param type Type name.
@@ -47,7 +47,7 @@ namespace ignite
                     // No-op.
                 }
                 
-                /*
+                /**
                  * Get type name.
                  *
                  * @return Type name.
@@ -57,7 +57,7 @@ namespace ignite
                     return type;
                 }
 
-                /*
+                /**
                  * Set type name.
                  *
                  * @param sql Type name.
@@ -67,7 +67,7 @@ namespace ignite
                     this->type = type;
                 }
 
-                /*
+                /**
                  * Get text string.
                  *
                  * @return text string.
@@ -77,7 +77,7 @@ namespace ignite
                     return text;
                 }
 
-                /*
+                /**
                  * Set text string.
                  *
                  * @param text Text string.
@@ -87,7 +87,7 @@ namespace ignite
                     this->text = text;
                 }
 
-                /*
+                /**
                  * Get page size.
                  *
                  * @return Page size.
@@ -97,7 +97,7 @@ namespace ignite
                     return pageSize;
                 }
 
-                /*
+                /**
                  * Set page size.
                  *
                  * @param pageSize Page size.
@@ -107,7 +107,7 @@ namespace ignite
                     this->pageSize = pageSize;
                 }
 
-                /*
+                /**
                  * Get local flag.
                  *
                  * @return Local flag.
@@ -117,17 +117,17 @@ namespace ignite
                     return loc;
                 }
 
-                /*
-                    * Set local flag.
-                    *
-                    * @param loc Local flag.
-                    */
+                /**
+                 * Set local flag.
+                 *
+                 * @param loc Local flag.
+                 */
                 void SetLocal(bool loc)
                 {
                     this->loc = loc;
                 }
                 
-                /*
+                /**
                  * Write query info to the stream.
                  *
                  * @param writer Writer.
@@ -141,16 +141,16 @@ namespace ignite
                 }
 
             private:
-                /* Type name. */
+                /** Type name. */
                 std::string type;
 
-                /* Text string. */
+                /** Text string. */
                 std::string text;
 
-                /* Page size. */
+                /** Page size. */
                 int32_t pageSize;
 
-                /* Local flag. */
+                /** Local flag. */
                 bool loc;
             };
         }

http://git-wip-us.apache.org/repos/asf/ignite/blob/77c6d08a/modules/platforms/cpp/core/include/ignite/ignition.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/ignition.h b/modules/platforms/cpp/core/include/ignite/ignition.h
index 93ce166..f0046b0 100644
--- a/modules/platforms/cpp/core/include/ignite/ignition.h
+++ b/modules/platforms/cpp/core/include/ignite/ignition.h
@@ -15,14 +15,6 @@
  * limitations under the License.
  */
 
-/**
- * \mainpage Apache Ignite C++
- *
- * Apache Ignite In-Memory Data Fabric is a high-performance, integrated and distributed
in-memory platform for
- * computing and transacting on large-scale data sets in real-time, orders of magnitude faster
than possible with
- * traditional disk-based or flash-based technologies.
- */
-
 #ifndef _IGNITE_IGNITION
 #define _IGNITE_IGNITION
 
@@ -46,7 +38,7 @@ namespace ignite
          */
         static Ignite Start(const IgniteConfiguration& cfg);
 
-        /*
+        /**
          * Start Ignite instance.
          *
          * @param cfg Configuration.

http://git-wip-us.apache.org/repos/asf/ignite/blob/77c6d08a/modules/platforms/cpp/core/include/ignite/impl/cache/cache_impl.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/impl/cache/cache_impl.h b/modules/platforms/cpp/core/include/ignite/impl/cache/cache_impl.h
index 31ebca1..546a97b 100644
--- a/modules/platforms/cpp/core/include/ignite/impl/cache/cache_impl.h
+++ b/modules/platforms/cpp/core/include/ignite/impl/cache/cache_impl.h
@@ -300,7 +300,7 @@ namespace ignite
                  */
                 query::QueryCursorImpl* QuerySql(const ignite::cache::query::SqlQuery&
qry, IgniteError* err);
 
-                /*
+                /**
                  * Invoke text query.
                  *
                  * @param qry Query.
@@ -309,7 +309,7 @@ namespace ignite
                  */
                 query::QueryCursorImpl* QueryText(const ignite::cache::query::TextQuery&
qry, IgniteError* err);
 
-                /*
+                /**
                  * Invoke scan query.
                  *
                  * @param qry Query.
@@ -318,7 +318,7 @@ namespace ignite
                  */
                 query::QueryCursorImpl* QueryScan(const ignite::cache::query::ScanQuery&
qry, IgniteError* err);
 
-                /*
+                /**
                  * Invoke sql fields query.
                  *
                  * @param qry Query.

http://git-wip-us.apache.org/repos/asf/ignite/blob/77c6d08a/modules/platforms/cpp/core/include/ignite/impl/operations.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/impl/operations.h b/modules/platforms/cpp/core/include/ignite/impl/operations.h
index 5423a56..9f1f333 100644
--- a/modules/platforms/cpp/core/include/ignite/impl/operations.h
+++ b/modules/platforms/cpp/core/include/ignite/impl/operations.h
@@ -154,7 +154,7 @@ namespace ignite
             IGNITE_NO_COPY_ASSIGNMENT(In3Operation)
         };
 
-        /*
+        /**
          * Input set operation.
          */
         template<typename T>
@@ -192,7 +192,7 @@ namespace ignite
         class InMapOperation : public InputOperation
         {
         public:
-            /*
+            /**
              * Constructor.
              *
              * @param val Value.
@@ -360,7 +360,7 @@ namespace ignite
             IGNITE_NO_COPY_ASSIGNMENT(Out2Operation)
         };
         
-        /*
+        /**
          * Output map operation.
          */
         template<typename T1, typename T2>
@@ -412,7 +412,7 @@ namespace ignite
             IGNITE_NO_COPY_ASSIGNMENT(OutMapOperation)
         };
 
-        /*
+        /**
          * Output query GET ALL operation.
          */
         template<typename K, typename V>

http://git-wip-us.apache.org/repos/asf/ignite/blob/77c6d08a/modules/platforms/cpp/cpp.dxg
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/cpp.dxg b/modules/platforms/cpp/cpp.dxg
index 281c32b..42b0a36 100644
--- a/modules/platforms/cpp/cpp.dxg
+++ b/modules/platforms/cpp/cpp.dxg
@@ -150,7 +150,7 @@ SHORT_NAMES            = NO
 # comments will behave just like regular Qt-style comments
 # (thus requiring an explicit @brief command for a brief description.)
 
-JAVADOC_AUTOBRIEF      = NO
+JAVADOC_AUTOBRIEF      = YES
 
 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
 # interpret the first line (until the first dot) of a Qt-style
@@ -1715,7 +1715,7 @@ GENERATE_LEGEND        = YES
 
 DOT_CLEANUP            = YES
 
-;INPUT=core/include/ignite core/src
+;INPUT=core
 ;EXCLUDE=core/include/ignite/impl core/os/linux/include/ignite/impl core/os/linux/src/impl
core/os/win/include/ignite/impl core/os/win/src/impl core/src/impl
 ;STRIP_FROM_PATH=core/include/ignite core/src
 ;OUTPUT_DIRECTORY=../../clients/target/cppdoc


Mime
View raw message