ignite-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From voze...@apache.org
Subject [03/50] [abbrv] ignite git commit: IGNITE-2187: CPP: Added documentation for files.
Date Thu, 24 Dec 2015 14:41:39 GMT
IGNITE-2187: CPP: Added documentation for files.


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

Branch: refs/heads/ignite-1626
Commit: 0c7dfec5d802832b0798c1982a543fd85af50acc
Parents: a34bcc8
Author: isapego <isapego@gridgain.com>
Authored: Fri Dec 18 18:04:46 2015 +0300
Committer: vozerov-gridgain <vozerov@gridgain.com>
Committed: Fri Dec 18 18:04:46 2015 +0300

----------------------------------------------------------------------
 modules/platforms/cpp/core/impl/doxygen.h       | 53 --------------------
 .../cpp/core/include/ignite/binary/binary.h     |  5 ++
 .../core/include/ignite/binary/binary_consts.h  |  5 ++
 .../include/ignite/binary/binary_containers.h   |  5 ++
 .../include/ignite/binary/binary_raw_reader.h   |  5 ++
 .../include/ignite/binary/binary_raw_writer.h   |  5 ++
 .../core/include/ignite/binary/binary_reader.h  |  5 ++
 .../core/include/ignite/binary/binary_type.h    | 17 +++++++
 .../core/include/ignite/binary/binary_writer.h  |  5 ++
 .../cpp/core/include/ignite/cache/cache.h       |  5 ++
 .../cpp/core/include/ignite/cache/cache_entry.h |  5 ++
 .../core/include/ignite/cache/cache_peek_mode.h |  5 ++
 .../cpp/core/include/ignite/cache/query/query.h |  5 ++
 .../include/ignite/cache/query/query_argument.h |  6 +++
 .../include/ignite/cache/query/query_cursor.h   |  5 ++
 .../ignite/cache/query/query_fields_cursor.h    |  5 ++
 .../ignite/cache/query/query_fields_row.h       |  5 ++
 .../include/ignite/cache/query/query_scan.h     |  5 ++
 .../core/include/ignite/cache/query/query_sql.h |  5 ++
 .../ignite/cache/query/query_sql_fields.h       |  5 ++
 .../include/ignite/cache/query/query_text.h     |  5 ++
 .../platforms/cpp/core/include/ignite/guid.h    |  5 ++
 .../platforms/cpp/core/include/ignite/ignite.h  |  5 ++
 .../core/include/ignite/ignite_configuration.h  |  5 ++
 .../cpp/core/include/ignite/ignite_error.h      |  5 ++
 .../cpp/core/include/ignite/ignition.h          |  5 ++
 modules/platforms/cpp/core/namespaces.dox       | 53 ++++++++++++++++++++
 27 files changed, 191 insertions(+), 53 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/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
deleted file mode 100644
index ed237f6..0000000
--- a/modules/platforms/cpp/core/impl/doxygen.h
+++ /dev/null
@@ -1,53 +0,0 @@
-/*
- * 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/0c7dfec5/modules/platforms/cpp/core/include/ignite/binary/binary.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/binary/binary.h b/modules/platforms/cpp/core/include/ignite/binary/binary.h
index 15476fe..1ffa3e5 100644
--- a/modules/platforms/cpp/core/include/ignite/binary/binary.h
+++ b/modules/platforms/cpp/core/include/ignite/binary/binary.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Includes all binary API headers.
+ */
+
 #ifndef _IGNITE_BINARY
 #define _IGNITE_BINARY
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/binary/binary_consts.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/binary/binary_consts.h b/modules/platforms/cpp/core/include/ignite/binary/binary_consts.h
index 7f0fd1e..db7cc38 100644
--- a/modules/platforms/cpp/core/include/ignite/binary/binary_consts.h
+++ b/modules/platforms/cpp/core/include/ignite/binary/binary_consts.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares specific binary constatants
+ */
+
 #ifndef _IGNITE_BINARY_CONSTS
 #define _IGNITE_BINARY_CONSTS
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/binary/binary_containers.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/binary/binary_containers.h b/modules/platforms/cpp/core/include/ignite/binary/binary_containers.h
index 61b7265..94b2c81 100644
--- a/modules/platforms/cpp/core/include/ignite/binary/binary_containers.h
+++ b/modules/platforms/cpp/core/include/ignite/binary/binary_containers.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares binary reader and writer types for the collections.
+ */
+
 #ifndef _IGNITE_BINARY_CONTAINERS
 #define _IGNITE_BINARY_CONTAINERS
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/binary/binary_raw_reader.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/binary/binary_raw_reader.h b/modules/platforms/cpp/core/include/ignite/binary/binary_raw_reader.h
index eb39c2d..d986225 100644
--- a/modules/platforms/cpp/core/include/ignite/binary/binary_raw_reader.h
+++ b/modules/platforms/cpp/core/include/ignite/binary/binary_raw_reader.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::binary::BinaryRawReader class.
+ */
+
 #ifndef _IGNITE_BINARY_RAW_READER
 #define _IGNITE_BINARY_RAW_READER
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/binary/binary_raw_writer.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/binary/binary_raw_writer.h b/modules/platforms/cpp/core/include/ignite/binary/binary_raw_writer.h
index 2c3e75b..9bbf4ed 100644
--- a/modules/platforms/cpp/core/include/ignite/binary/binary_raw_writer.h
+++ b/modules/platforms/cpp/core/include/ignite/binary/binary_raw_writer.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::binary::BinaryRawWriter class.
+ */
+
 #ifndef _IGNITE_BINARY_RAW_WRITER
 #define _IGNITE_BINARY_RAW_WRITER
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/binary/binary_reader.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/binary/binary_reader.h b/modules/platforms/cpp/core/include/ignite/binary/binary_reader.h
index 75d2384..e991d4e 100644
--- a/modules/platforms/cpp/core/include/ignite/binary/binary_reader.h
+++ b/modules/platforms/cpp/core/include/ignite/binary/binary_reader.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::binary::BinaryReader class.
+ */
+
 #ifndef _IGNITE_BINARY_READER
 #define _IGNITE_BINARY_READER
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/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 353b3bb..636171e 100644
--- a/modules/platforms/cpp/core/include/ignite/binary/binary_type.h
+++ b/modules/platforms/cpp/core/include/ignite/binary/binary_type.h
@@ -15,6 +15,12 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::binary::BinaryType class template and helping macros
+ * to declare binary type specialisation for user types.
+ */
+
 #ifndef _IGNITE_BINARY_TYPE
 #define _IGNITE_BINARY_TYPE
 
@@ -25,6 +31,7 @@
 #include "ignite/ignite_error.h"
 
 /**
+ * @def IGNITE_BINARY_TYPE_START(T)
  * Start binary type definition.
  */
 #define IGNITE_BINARY_TYPE_START(T) \
@@ -33,12 +40,14 @@ struct BinaryType<T> \
 {
 
 /**
+ * @def IGNITE_BINARY_TYPE_END
  * End binary type definition.
  */
 #define IGNITE_BINARY_TYPE_END \
 };
 
 /**
+ * @def IGNITE_BINARY_GET_TYPE_ID_AS_CONST(id)
  * Implementation of GetTypeId() which returns predefined constant.
  */
 #define IGNITE_BINARY_GET_TYPE_ID_AS_CONST(id) \
@@ -48,6 +57,7 @@ int32_t GetTypeId() \
 }
 
 /**
+ * @def IGNITE_BINARY_GET_TYPE_ID_AS_HASH(typeName)
  * Implementation of GetTypeId() which returns hash of passed type name.
  */
 #define IGNITE_BINARY_GET_TYPE_ID_AS_HASH(typeName) \
@@ -57,6 +67,7 @@ int32_t GetTypeId() \
 }
 
 /**
+ * @def IGNITE_BINARY_GET_TYPE_NAME_AS_IS(typeName)
  * Implementation of GetTypeName() which returns type name as is.
  */
 #define IGNITE_BINARY_GET_TYPE_NAME_AS_IS(typeName) \
@@ -66,6 +77,7 @@ std::string GetTypeName() \
 }
 
 /**
+ * @def IGNITE_BINARY_GET_FIELD_ID_AS_HASH
  * Default implementation of GetFieldId() function which returns Java-way hash code of the
string.
  */
 #define IGNITE_BINARY_GET_FIELD_ID_AS_HASH \
@@ -75,6 +87,7 @@ int32_t GetFieldId(const char* name) \
 }
 
 /**
+ * @def IGNITE_BINARY_GET_HASH_CODE_ZERO(T)
  * Implementation of GetHashCode() function which always returns 0.
  */
 #define IGNITE_BINARY_GET_HASH_CODE_ZERO(T) \
@@ -84,6 +97,7 @@ int32_t GetHashCode(const T& obj) \
 }
 
 /**
+ * @def IGNITE_BINARY_IS_NULL_FALSE(T)
  * Implementation of IsNull() function which always returns false.
  */
 #define IGNITE_BINARY_IS_NULL_FALSE(T) \
@@ -93,6 +107,7 @@ bool IsNull(const T& obj) \
 }
 
 /**
+ * @def IGNITE_BINARY_IS_NULL_IF_NULLPTR(T)
  * Implementation of IsNull() function which return true if passed object is null pointer.
  */
 #define IGNITE_BINARY_IS_NULL_IF_NULLPTR(T) \
@@ -102,6 +117,7 @@ bool IsNull(const T& obj) \
 }
 
 /**
+ * @def IGNITE_BINARY_GET_NULL_DEFAULT_CTOR(T)
  * Implementation of GetNull() function which returns an instance created with defult constructor.
  */
 #define IGNITE_BINARY_GET_NULL_DEFAULT_CTOR(T) \
@@ -111,6 +127,7 @@ T GetNull() \
 }
 
 /**
+ * @def IGNITE_BINARY_GET_NULL_NULLPTR(T)
  * Implementation of GetNull() function which returns NULL pointer.
  */
 #define IGNITE_BINARY_GET_NULL_NULLPTR(T) \

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/binary/binary_writer.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/binary/binary_writer.h b/modules/platforms/cpp/core/include/ignite/binary/binary_writer.h
index 0c7cc68..475f454 100644
--- a/modules/platforms/cpp/core/include/ignite/binary/binary_writer.h
+++ b/modules/platforms/cpp/core/include/ignite/binary/binary_writer.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::binary::BinaryWriter class.
+ */
+
 #ifndef _IGNITE_BINARY_WRITER
 #define _IGNITE_BINARY_WRITER
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/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 ad23d62..6727293 100644
--- a/modules/platforms/cpp/core/include/ignite/cache/cache.h
+++ b/modules/platforms/cpp/core/include/ignite/cache/cache.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::cache::Cache class.
+ */
+
 #ifndef _IGNITE_CACHE
 #define _IGNITE_CACHE
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/cache/cache_entry.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/cache/cache_entry.h b/modules/platforms/cpp/core/include/ignite/cache/cache_entry.h
index d6d244d..9ca3946 100644
--- a/modules/platforms/cpp/core/include/ignite/cache/cache_entry.h
+++ b/modules/platforms/cpp/core/include/ignite/cache/cache_entry.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::cache::CacheEntry class.
+ */
+
 #ifndef _IGNITE_CACHE_ENTRY
 #define _IGNITE_CACHE_ENTRY
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/cache/cache_peek_mode.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/cache/cache_peek_mode.h b/modules/platforms/cpp/core/include/ignite/cache/cache_peek_mode.h
index be61887..192013d 100644
--- a/modules/platforms/cpp/core/include/ignite/cache/cache_peek_mode.h
+++ b/modules/platforms/cpp/core/include/ignite/cache/cache_peek_mode.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::cache::CachePeekMode enum.
+ */
+
 #ifndef _IGNITE_CACHE_PEEK_MODE
 #define _IGNITE_CACHE_PEEK_MODE
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/cache/query/query.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/cache/query/query.h b/modules/platforms/cpp/core/include/ignite/cache/query/query.h
index c469e85..de7578e 100644
--- a/modules/platforms/cpp/core/include/ignite/cache/query/query.h
+++ b/modules/platforms/cpp/core/include/ignite/cache/query/query.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Includes all query API headers.
+ */
+
 #ifndef _IGNITE_QUERY
 #define _IGNITE_QUERY
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/cache/query/query_argument.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/cache/query/query_argument.h b/modules/platforms/cpp/core/include/ignite/cache/query/query_argument.h
index 37871c9..5cd22a6 100644
--- a/modules/platforms/cpp/core/include/ignite/cache/query/query_argument.h
+++ b/modules/platforms/cpp/core/include/ignite/cache/query/query_argument.h
@@ -15,6 +15,12 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::cache::query::QueryArgument class template and
+ * ignite::cache::query::QueryArgumentBase interface.
+ */
+
 #ifndef _IGNITE_CACHE_QUERY_ARGUMENT
 #define _IGNITE_CACHE_QUERY_ARGUMENT
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/cache/query/query_cursor.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/cache/query/query_cursor.h b/modules/platforms/cpp/core/include/ignite/cache/query/query_cursor.h
index 4ef2405..6f507d2 100644
--- a/modules/platforms/cpp/core/include/ignite/cache/query/query_cursor.h
+++ b/modules/platforms/cpp/core/include/ignite/cache/query/query_cursor.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::cache::query::QueryCursor class template.
+ */
+
 #ifndef _IGNITE_CACHE_QUERY_CURSOR
 #define _IGNITE_CACHE_QUERY_CURSOR
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/cache/query/query_fields_cursor.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/cache/query/query_fields_cursor.h b/modules/platforms/cpp/core/include/ignite/cache/query/query_fields_cursor.h
index 8410c81..b74ae5a 100644
--- a/modules/platforms/cpp/core/include/ignite/cache/query/query_fields_cursor.h
+++ b/modules/platforms/cpp/core/include/ignite/cache/query/query_fields_cursor.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::cache::query::QueryFieldsCursor class.
+ */
+
 #ifndef _IGNITE_CACHE_QUERY_FIELDS_CURSOR
 #define _IGNITE_CACHE_QUERY_FIELDS_CURSOR
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/cache/query/query_fields_row.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/cache/query/query_fields_row.h b/modules/platforms/cpp/core/include/ignite/cache/query/query_fields_row.h
index 1e70a8d..bb10e9e 100644
--- a/modules/platforms/cpp/core/include/ignite/cache/query/query_fields_row.h
+++ b/modules/platforms/cpp/core/include/ignite/cache/query/query_fields_row.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::cache::query::QueryFieldsRow class.
+ */
+
 #ifndef _IGNITE_CACHE_QUERY_FIELDS_ROW
 #define _IGNITE_CACHE_QUERY_FIELDS_ROW
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/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 fa47269..7bd6bbb 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
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::cache::query::ScanQuery class.
+ */
+
 #ifndef _IGNITE_CACHE_QUERY_SCAN
 #define _IGNITE_CACHE_QUERY_SCAN
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/cache/query/query_sql.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/cache/query/query_sql.h b/modules/platforms/cpp/core/include/ignite/cache/query/query_sql.h
index 8feb785..186e6e3 100644
--- a/modules/platforms/cpp/core/include/ignite/cache/query/query_sql.h
+++ b/modules/platforms/cpp/core/include/ignite/cache/query/query_sql.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::cache::query::SqlQuery class.
+ */
+
 #ifndef _IGNITE_CACHE_QUERY_SQL
 #define _IGNITE_CACHE_QUERY_SQL
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/cache/query/query_sql_fields.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/cache/query/query_sql_fields.h b/modules/platforms/cpp/core/include/ignite/cache/query/query_sql_fields.h
index e720cdf..7076595 100644
--- a/modules/platforms/cpp/core/include/ignite/cache/query/query_sql_fields.h
+++ b/modules/platforms/cpp/core/include/ignite/cache/query/query_sql_fields.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::cache::query::SqlFieldsQuery class.
+ */
+
 #ifndef _IGNITE_CACHE_QUERY_SQL_FIELDS
 #define _IGNITE_CACHE_QUERY_SQL_FIELDS
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/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 4494883..b68f65e 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
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::cache::query::TextQuery class.
+ */
+
 #ifndef _IGNITE_CACHE_QUERY_TEXT
 #define _IGNITE_CACHE_QUERY_TEXT
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/guid.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/guid.h b/modules/platforms/cpp/core/include/ignite/guid.h
index 9469769..a9999e7 100644
--- a/modules/platforms/cpp/core/include/ignite/guid.h
+++ b/modules/platforms/cpp/core/include/ignite/guid.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::Guid class.
+ */
+
 #ifndef _IGNITE_GUID
 #define _IGNITE_GUID
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/ignite.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/ignite.h b/modules/platforms/cpp/core/include/ignite/ignite.h
index f194b1a..25b9f0c 100644
--- a/modules/platforms/cpp/core/include/ignite/ignite.h
+++ b/modules/platforms/cpp/core/include/ignite/ignite.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::Ignite class.
+ */
+
 #ifndef _IGNITE
 #define _IGNITE
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/ignite_configuration.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/ignite_configuration.h b/modules/platforms/cpp/core/include/ignite/ignite_configuration.h
index c4c6c8e..e46e2bd 100644
--- a/modules/platforms/cpp/core/include/ignite/ignite_configuration.h
+++ b/modules/platforms/cpp/core/include/ignite/ignite_configuration.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::IgniteConfiguration class.
+ */
+
 #ifndef _IGNITE_CONFIGURATION
 #define _IGNITE_CONFIGURATION
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/include/ignite/ignite_error.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/include/ignite/ignite_error.h b/modules/platforms/cpp/core/include/ignite/ignite_error.h
index b1fc772..3b192b1 100644
--- a/modules/platforms/cpp/core/include/ignite/ignite_error.h
+++ b/modules/platforms/cpp/core/include/ignite/ignite_error.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::IgniteError class.
+ */
+
 #ifndef _IGNITE_ERROR
 #define _IGNITE_ERROR
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/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 f0046b0..fe594ec 100644
--- a/modules/platforms/cpp/core/include/ignite/ignition.h
+++ b/modules/platforms/cpp/core/include/ignite/ignition.h
@@ -15,6 +15,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file
+ * Declares ignite::Ignition class.
+ */
+
 #ifndef _IGNITE_IGNITION
 #define _IGNITE_IGNITION
 

http://git-wip-us.apache.org/repos/asf/ignite/blob/0c7dfec5/modules/platforms/cpp/core/namespaces.dox
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/core/namespaces.dox b/modules/platforms/cpp/core/namespaces.dox
new file mode 100644
index 0000000..ed237f6
--- /dev/null
+++ b/modules/platforms/cpp/core/namespaces.dox
@@ -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


Mime
View raw message