geode-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jbarr...@apache.org
Subject [geode-native] branch develop updated: GEODE-4271: Fixes doxygen document compile
Date Wed, 10 Jan 2018 21:13:25 GMT
This is an automated email from the ASF dual-hosted git repository.

jbarrett pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode-native.git


The following commit(s) were added to refs/heads/develop by this push:
     new 9830aa0  GEODE-4271: Fixes doxygen document compile
9830aa0 is described below

commit 9830aa087dd68f51dc8f5d7d5c3343fc3dacc557
Author: Jacob Barrett <jbarrett@pivotal.io>
AuthorDate: Wed Jan 10 13:13:23 2018 -0800

    GEODE-4271: Fixes doxygen document compile
    
    - Fixes path to source.
    - Cleans up unused parameters.
---
 cppcache/include/geode/CqAttributes.hpp   | 18 ++++++------------
 cppcache/include/geode/CqListener.hpp     | 13 +++++--------
 cppcache/include/geode/CqOperation.hpp    |  1 -
 cppcache/include/geode/CqQuery.hpp        |  3 ---
 cppcache/include/geode/CqStatistics.hpp   | 13 +++++--------
 cppcache/include/geode/QueryService.hpp   |  9 ---------
 cppcache/include/geode/RegionShortcut.hpp |  8 ++++----
 cppcache/src/CqEventImpl.hpp              | 20 +++++++-------------
 docs/api/clicache/Doxyfile.in             |  2 +-
 docs/api/cppcache/Doxyfile.in             | 15 ++-------------
 10 files changed, 30 insertions(+), 72 deletions(-)

diff --git a/cppcache/include/geode/CqAttributes.hpp b/cppcache/include/geode/CqAttributes.hpp
index 128a4b4..7810447 100644
--- a/cppcache/include/geode/CqAttributes.hpp
+++ b/cppcache/include/geode/CqAttributes.hpp
@@ -1,8 +1,3 @@
-#pragma once
-
-#ifndef GEODE_CQATTRIBUTES_H_
-#define GEODE_CQATTRIBUTES_H_
-
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
@@ -20,22 +15,21 @@
  * limitations under the License.
  */
 
-#include "internal/geode_globals.hpp"
+#pragma once
+
+#ifndef GEODE_CQATTRIBUTES_H_
+#define GEODE_CQATTRIBUTES_H_
+
 #include <vector>
 
+#include "internal/geode_globals.hpp"
 #include "CqListener.hpp"
-/**
- * @file
- */
 
 namespace apache {
 namespace geode {
 namespace client {
 
 /**
- * @cacheserver
- * Querying is only supported for native clients.
- * @endcacheserver
  * @class CqAttributes CqAttributes.hpp
  *
  * This interface holds all attribute values for a CQ and provides methods for
diff --git a/cppcache/include/geode/CqListener.hpp b/cppcache/include/geode/CqListener.hpp
index e2b1fc8..e4d623b 100644
--- a/cppcache/include/geode/CqListener.hpp
+++ b/cppcache/include/geode/CqListener.hpp
@@ -1,8 +1,3 @@
-#pragma once
-
-#ifndef GEODE_CQLISTENER_H_
-#define GEODE_CQLISTENER_H_
-
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
@@ -20,6 +15,11 @@
  * limitations under the License.
  */
 
+#pragma once
+
+#ifndef GEODE_CQLISTENER_H_
+#define GEODE_CQLISTENER_H_
+
 #include "internal/geode_globals.hpp"
 #include "CqEvent.hpp"
 
@@ -32,9 +32,6 @@ namespace geode {
 namespace client {
 class CacheListener;
 /**
- * @cacheserver
- * Querying is only supported for native clients.
- * @endcacheserver
  * @class CqListener CqListener.hpp
  *
  * Application plug-in interface for handling continuous query events after
diff --git a/cppcache/include/geode/CqOperation.hpp b/cppcache/include/geode/CqOperation.hpp
index 38b8fbc..678e621 100644
--- a/cppcache/include/geode/CqOperation.hpp
+++ b/cppcache/include/geode/CqOperation.hpp
@@ -30,7 +30,6 @@ namespace apache {
 namespace geode {
 namespace client {
 /**
- * @class Operation CqOperation.hpp
  * Enumerated type for Operation actions.
  */
 class _GEODE_EXPORT CqOperation {
diff --git a/cppcache/include/geode/CqQuery.hpp b/cppcache/include/geode/CqQuery.hpp
index 3cf8ccf..c8f3756 100644
--- a/cppcache/include/geode/CqQuery.hpp
+++ b/cppcache/include/geode/CqQuery.hpp
@@ -115,8 +115,6 @@ class _GEODE_EXPORT CqQuery {
       std::chrono::milliseconds timeout = DEFAULT_QUERY_RESPONSE_TIMEOUT) = 0;
 
   /**
-   * @notsupported_cacheserver
-   * @nativeclient
    * Executes the OQL Query on the cache server and returns the results.
    *
    * @throws RegionNotFoundException if the specified region in the
@@ -129,7 +127,6 @@ class _GEODE_EXPORT CqQuery {
    * configured with locators, if no locators are available, the cause of
    * NotConnectedException
    * is set to NoAvailableLocatorsException.
-   * @endnativeclient
    */
   virtual void execute() = 0;
 
diff --git a/cppcache/include/geode/CqStatistics.hpp b/cppcache/include/geode/CqStatistics.hpp
index ba01530..d3c61f3 100644
--- a/cppcache/include/geode/CqStatistics.hpp
+++ b/cppcache/include/geode/CqStatistics.hpp
@@ -1,8 +1,3 @@
-#pragma once
-
-#ifndef GEODE_CQSTATISTICS_H_
-#define GEODE_CQSTATISTICS_H_
-
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
@@ -20,6 +15,11 @@
  * limitations under the License.
  */
 
+#pragma once
+
+#ifndef GEODE_CQSTATISTICS_H_
+#define GEODE_CQSTATISTICS_H_
+
 #include "internal/geode_globals.hpp"
 
 /**
@@ -31,9 +31,6 @@ namespace geode {
 namespace client {
 
 /**
- * @cacheserver
- * Querying is only supported for native clients.
- * @endcacheserver
  * @class CqStatistics CqStatistics.hpp
  *
  * This class provides methods to get statistical information about a registered
diff --git a/cppcache/include/geode/QueryService.hpp b/cppcache/include/geode/QueryService.hpp
index 87ff877..a03132a 100644
--- a/cppcache/include/geode/QueryService.hpp
+++ b/cppcache/include/geode/QueryService.hpp
@@ -58,7 +58,6 @@ class _GEODE_EXPORT QueryService {
   virtual std::shared_ptr<Query> newQuery(std::string querystr) = 0;
 
   /**
-   * @nativeclient
    * Constructs a new named continuous query, represented by an instance of
    * CqQuery. The CqQuery is not executed, however, until the execute method
    * is invoked on the CqQuery. The name of the query will be used
@@ -87,8 +86,6 @@ class _GEODE_EXPORT QueryService {
    * region path.
    *         Bind parameters in the query are not supported for the initial
    * release.
-   *
-   * @endnativeclient
    */
   virtual std::shared_ptr<CqQuery> newCq(
       std::string name, std::string querystr,
@@ -131,10 +128,8 @@ class _GEODE_EXPORT QueryService {
       bool isDurable = false) = 0;
 
   /**
-   * @nativeclient
    * Close all CQs, and release resources
    * associated with executing CQs.
-   * @endnativeclient
    */
   virtual void closeCqs() = 0;
 
@@ -146,10 +141,8 @@ class _GEODE_EXPORT QueryService {
   virtual query_container_type getCqs() const = 0;
 
   /**
-   * @nativeclient
    * Retrieve a CqQuery by name.
    * @return the CqQuery or nullptr if not found
-   * @endnativeclient
    */
   virtual std::shared_ptr<CqQuery> getCq(const std::string& name) const = 0;
 
@@ -161,9 +154,7 @@ class _GEODE_EXPORT QueryService {
   virtual void executeCqs() = 0;
 
   /**
-   * @nativeclient
    * Stops all the cqs on this client.
-   * @endnativeclient
    */
   virtual void stopCqs() = 0;
 
diff --git a/cppcache/include/geode/RegionShortcut.hpp b/cppcache/include/geode/RegionShortcut.hpp
index 6ea99e3..e56bcbf 100644
--- a/cppcache/include/geode/RegionShortcut.hpp
+++ b/cppcache/include/geode/RegionShortcut.hpp
@@ -22,6 +22,10 @@
 
 #include "internal/geode_globals.hpp"
 
+namespace apache {
+namespace geode {
+namespace client {
+
 /**
  * Each enum represents a predefined {@link RegionAttributes} in a {@link
  * Cache}.
@@ -31,10 +35,6 @@
  * the refid attribute on a region element or region-attributes element to the
  * string of each value.
  */
-namespace apache {
-namespace geode {
-namespace client {
-
 enum RegionShortcut {
 
   /**
diff --git a/cppcache/src/CqEventImpl.hpp b/cppcache/src/CqEventImpl.hpp
index 38e6f5a..e81a713 100644
--- a/cppcache/src/CqEventImpl.hpp
+++ b/cppcache/src/CqEventImpl.hpp
@@ -1,8 +1,3 @@
-#pragma once
-
-#ifndef GEODE_CQEVENTIMPL_H_
-#define GEODE_CQEVENTIMPL_H_
-
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
@@ -20,6 +15,13 @@
  * limitations under the License.
  */
 
+#pragma once
+
+#ifndef GEODE_CQEVENTIMPL_H_
+#define GEODE_CQEVENTIMPL_H_
+
+#include <string>
+
 #include <geode/internal/geode_globals.hpp>
 #include <geode/CqEvent.hpp>
 #include <geode/CqOperation.hpp>
@@ -27,20 +29,12 @@
 #include <geode/CacheableKey.hpp>
 #include <geode/Cacheable.hpp>
 #include <geode/Exception.hpp>
-#include <string>
-
-/**
- * @file
- */
 
 namespace apache {
 namespace geode {
 namespace client {
 
 /**
- * @cacheserver
- * Querying is only supported for native clients.
- * @endcacheserver
  * @class CqEventImpl EventImpl.hpp
  *
  * Interface for CqEvent. Offers methods to get information from
diff --git a/docs/api/clicache/Doxyfile.in b/docs/api/clicache/Doxyfile.in
index 99d0d2f..5e5442e 100644
--- a/docs/api/clicache/Doxyfile.in
+++ b/docs/api/clicache/Doxyfile.in
@@ -80,7 +80,7 @@ HIDE_UNDOC_CLASSES     = YES
 HIDE_UNDOC_MEMBERS     = YES
 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/footer.html
 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@
-INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/../../clicache
+INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/../../../clicache
 JAVADOC_AUTOBRIEF      = YES
 MACRO_EXPANSION        = YES
 OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@
diff --git a/docs/api/cppcache/Doxyfile.in b/docs/api/cppcache/Doxyfile.in
index 4bd7357..0f25c0a 100644
--- a/docs/api/cppcache/Doxyfile.in
+++ b/docs/api/cppcache/Doxyfile.in
@@ -58,19 +58,8 @@ ENABLE_PREPROCESSING   = YES
 # Don't generate class diagrams
 CLASS_DIAGRAMS         = NO
 
-# Add aliases to selectivly hide comments
-ALIASES = "cacheserver=\if cacheserver" \
-	  "endcacheserver=\endif"  \
-	  "nativeclient=\if nativeclient"  \
-	  "endnativeclient=\endif" \
-	  "notsupported_cacheserver=\if cacheserver \
-This functionality is unsupported in the C++ Cache Server Product. \endif" \
-	  "notsupported_nativeclient=\if nativeclient \
-This functionality is unsupported in the Native Client Product. \endif" \
-
 ALPHABETICAL_INDEX     = YES
-ENABLED_SECTIONS       = nativeclient 
-EXCLUDE_PATTERNS       = */impl/* AtomicBits.hpp AtomicInc.hpp AtomicOpT.hpp BridgeLoader.hpp
CacheableToken.hpp Debug.hpp ExpirationAttributes.hpp geode_globals.hpp Lock.hpp SpinLock.hpp
Task.hpp Timecode.hpp 
+EXCLUDE_PATTERNS       = */internal/*
 EXTRACT_PRIVATE        = NO
 EXTRACT_STATIC         = NO
 FILE_PATTERNS          = *.h *.hpp statistics/*.hpp
@@ -80,7 +69,7 @@ HIDE_UNDOC_CLASSES     = YES
 HIDE_UNDOC_MEMBERS     = YES
 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/footer.html
 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@
-INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/../../cppcache/include/geode  @CMAKE_CURRENT_SOURCE_DIR@/../../cppcache/include/geode/statistics
+INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/../../../cppcache/include/geode
 JAVADOC_AUTOBRIEF      = YES
 MACRO_EXPANSION        = YES
 OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@

-- 
To stop receiving notification emails like this one, please contact
['"commits@geode.apache.org" <commits@geode.apache.org>'].

Mime
View raw message