geode-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mmart...@apache.org
Subject [geode-native] 01/01: Fix some documentation bugs: - adding missing class comments - fixed class comments that were in the wrong place
Date Fri, 26 Oct 2018 20:30:52 GMT
This is an automated email from the ASF dual-hosted git repository.

mmartell pushed a commit to branch GEODE-5919-api-docs-bugs
in repository https://gitbox.apache.org/repos/asf/geode-native.git

commit e213545c84c85cd81c8c0368c4b4d2bac2ae33dc
Author: Mike Martell <mmartell@pivotal.io>
AuthorDate: Fri Oct 26 13:30:30 2018 -0700

    Fix some documentation bugs:
    - adding missing class comments
    - fixed class comments that were in the wrong place
---
 clicache/src/IDataSerializable.hpp                 |  3 +++
 clicache/src/TypeRegistry.hpp                      |  4 +++-
 cppcache/include/geode/AuthenticatedView.hpp       | 15 +++------------
 cppcache/include/geode/CacheTransactionManager.hpp |  5 +++++
 cppcache/include/geode/CacheableEnum.hpp           | 12 ++++++------
 cppcache/include/geode/CacheableFileName.hpp       |  9 +++++----
 cppcache/include/geode/CacheableObjectArray.hpp    |  9 +++++----
 cppcache/include/geode/CacheableUndefined.hpp      |  4 ++++
 cppcache/include/geode/DataSerializable.hpp        |  2 +-
 cppcache/include/geode/Delta.hpp                   |  6 +++---
 cppcache/include/geode/EntryEvent.hpp              |  5 +++--
 cppcache/include/geode/PdxSerializable.hpp         |  3 +++
 cppcache/include/geode/Serializable.hpp            |  2 +-
 cppcache/include/geode/TypeRegistry.hpp            |  5 +++++
 14 files changed, 50 insertions(+), 34 deletions(-)

diff --git a/clicache/src/IDataSerializable.hpp b/clicache/src/IDataSerializable.hpp
index 56ed0fc..29bcffd 100644
--- a/clicache/src/IDataSerializable.hpp
+++ b/clicache/src/IDataSerializable.hpp
@@ -37,6 +37,9 @@ namespace Apache
       ref class DataOutput;
       ref class DataInput;
 
+      /// <summary>
+	  /// An interface for objects whose contents can be serialized as primitive types.
+      /// </summary>
       public interface class IDataSerializable : public ISerializable
       {
       public:
diff --git a/clicache/src/TypeRegistry.hpp b/clicache/src/TypeRegistry.hpp
index 6ebd02e..45f4e91 100644
--- a/clicache/src/TypeRegistry.hpp
+++ b/clicache/src/TypeRegistry.hpp
@@ -36,7 +36,9 @@ namespace Apache
       namespace native = apache::geode::client;
       
       ref class Cache;
-
+      /// <summary>
+      /// Registry for custom serializable types, both PDXSerializable and DataSerializable.
+      /// </summary>
       public ref class TypeRegistry
       {
       public:
diff --git a/cppcache/include/geode/AuthenticatedView.hpp b/cppcache/include/geode/AuthenticatedView.hpp
index aeb045c..13cd365 100644
--- a/cppcache/include/geode/AuthenticatedView.hpp
+++ b/cppcache/include/geode/AuthenticatedView.hpp
@@ -39,19 +39,10 @@ class UserAttributes;
 class FunctionServiceImpl;
 
 /**
- * @class Cache Cache.hpp
- *
- * Caches are obtained from static methods on the {@link CacheFactory} class
- * <p>
- * When a cache is created a {@link DistributedSystem} must be specified.
- * <p>
- * When a cache will no longer be used, it should be {@link #close closed}.
- * Once it {@link Cache::isClosed is closed} any attempt to use it
- * will cause a <code>CacheClosedException</code> to be thrown.
- *
- * <p>A cache can have multiple root regions, each with a different name.
- *
+ * Creates an authenticated cache view to allow credential based access to
+ * region services.
  */
+
 class APACHE_GEODE_EXPORT AuthenticatedView : public RegionService {
   /**
    * @brief public methods
diff --git a/cppcache/include/geode/CacheTransactionManager.hpp b/cppcache/include/geode/CacheTransactionManager.hpp
index fbd2931..a5154d5 100644
--- a/cppcache/include/geode/CacheTransactionManager.hpp
+++ b/cppcache/include/geode/CacheTransactionManager.hpp
@@ -32,6 +32,11 @@ namespace apache {
 namespace geode {
 namespace client {
 
+/**
+ * An interface for objects who perform transaction management
+ *
+ */
+
 class APACHE_GEODE_EXPORT CacheTransactionManager {
  public:
   /** Creates a new transaction and associates it with the current thread.
diff --git a/cppcache/include/geode/CacheableEnum.hpp b/cppcache/include/geode/CacheableEnum.hpp
index 0ad0d3a..4360a11 100644
--- a/cppcache/include/geode/CacheableEnum.hpp
+++ b/cppcache/include/geode/CacheableEnum.hpp
@@ -32,10 +32,14 @@ namespace apache {
 namespace geode {
 namespace client {
 
+class DataInput;
+class DataOutput;
+class Serializable;
+
 /**
  * Since C++ enums cannot be directly passed as a parameter to PdxWriter's
- * writeObject and PdxReader's readObject api
- * wrap C++ enum in to a immutable wrapper CacheableEnum class type by
+ * writeObject and PdxReader's readObject api,
+ * wrap C++ enums with an immutable wrapper CacheableEnum class type by
  * specifying enum class name, enum value name and its ordinal. C++ enum allows
  * explicit setting of ordinal number, but it is up to the user to map java
  * enumName with that of C++ enumName. Currently this wrapper only works as part
@@ -46,10 +50,6 @@ namespace client {
  * @see PdxReader#readObject
  */
 
-class DataInput;
-class DataOutput;
-class Serializable;
-
 class APACHE_GEODE_EXPORT CacheableEnum
     : public internal::DataSerializablePrimitive,
       public CacheableKey {
diff --git a/cppcache/include/geode/CacheableFileName.hpp b/cppcache/include/geode/CacheableFileName.hpp
index e5b1fe0..38cb037 100644
--- a/cppcache/include/geode/CacheableFileName.hpp
+++ b/cppcache/include/geode/CacheableFileName.hpp
@@ -33,14 +33,15 @@ namespace apache {
 namespace geode {
 namespace client {
 
-/**
- * Implement an immutable wrapper for filenames that can serve as a
- * distributable filename object for caching as both key and value.
- */
 class DataInput;
 class DataOutput;
 class Serializable;
 
+/**
+ * Implements an immutable wrapper for filenames that can serve as a
+ * distributable filename object for caching as both key and value.
+ */
+
 class APACHE_GEODE_EXPORT CacheableFileName : public CacheableString {
  public:
   inline CacheableFileName() = default;
diff --git a/cppcache/include/geode/CacheableObjectArray.hpp b/cppcache/include/geode/CacheableObjectArray.hpp
index ff4b84a..8009091 100644
--- a/cppcache/include/geode/CacheableObjectArray.hpp
+++ b/cppcache/include/geode/CacheableObjectArray.hpp
@@ -35,14 +35,15 @@ namespace apache {
 namespace geode {
 namespace client {
 
-/**
- * Implement an immutable Vector of <code>Cacheable</code> objects
- * that can serve as a distributable object for caching.
- */
 class DataInput;
 class DataOutput;
 class Serializable;
 
+/**
+ * Implements an immutable Vector of <code>Cacheable</code> objects
+ * that can serve as a distributable object for caching.
+ */
+
 class APACHE_GEODE_EXPORT CacheableObjectArray
     : public internal::DataSerializablePrimitive,
       public std::vector<std::shared_ptr<Cacheable>> {
diff --git a/cppcache/include/geode/CacheableUndefined.hpp b/cppcache/include/geode/CacheableUndefined.hpp
index 1a5a0eb..3a9e580 100644
--- a/cppcache/include/geode/CacheableUndefined.hpp
+++ b/cppcache/include/geode/CacheableUndefined.hpp
@@ -38,6 +38,10 @@ class DataInput;
 class DataOutput;
 class Serializable;
 
+/**
+ * Implements a DataSerializable object for undefined query results.
+ */
+
 class APACHE_GEODE_EXPORT CacheableUndefined
     : public internal::DataSerializableFixedId_t<
           internal::DSFid::CacheableUndefined> {
diff --git a/cppcache/include/geode/DataSerializable.hpp b/cppcache/include/geode/DataSerializable.hpp
index 1bca57f..644d7ca 100644
--- a/cppcache/include/geode/DataSerializable.hpp
+++ b/cppcache/include/geode/DataSerializable.hpp
@@ -34,7 +34,7 @@ class DataOutput;
 class DataInput;
 
 /**
- * An interface for objects whose state can be written/read as primitive types.
+ * An interface for objects whose contents can be serialized as primitive types.
  */
 class APACHE_GEODE_EXPORT DataSerializable : public virtual Serializable {
  public:
diff --git a/cppcache/include/geode/Delta.hpp b/cppcache/include/geode/Delta.hpp
index 8d60b9e..ca81336 100644
--- a/cppcache/include/geode/Delta.hpp
+++ b/cppcache/include/geode/Delta.hpp
@@ -32,6 +32,9 @@ namespace apache {
 namespace geode {
 namespace client {
 
+class DataInput;
+class DataOutput;
+
 /**
  * This interface is used for delta propagation.
  * To use delta propagation, an application class must derive from <code>class
@@ -44,9 +47,6 @@ namespace client {
  * of the class.
  */
 
-class DataInput;
-class DataOutput;
-
 class APACHE_GEODE_EXPORT Delta {
  public:
   /**
diff --git a/cppcache/include/geode/EntryEvent.hpp b/cppcache/include/geode/EntryEvent.hpp
index c214ae6..73b8c1d 100644
--- a/cppcache/include/geode/EntryEvent.hpp
+++ b/cppcache/include/geode/EntryEvent.hpp
@@ -34,12 +34,13 @@ namespace apache {
 namespace geode {
 namespace client {
 
-/** Represents an entry event affecting an entry, including its identity and the
- * the circumstances of the event. */
 class CacheableKey;
 class Region;
 class Serializable;
 
+/** Represents an entry event affecting an entry, including its identity and the
+ * the circumstances of the event. */
+
 class APACHE_GEODE_EXPORT EntryEvent {
  protected:
   std::shared_ptr<Region> m_region;      /**< Region */
diff --git a/cppcache/include/geode/PdxSerializable.hpp b/cppcache/include/geode/PdxSerializable.hpp
index 128e514..dcf6783 100644
--- a/cppcache/include/geode/PdxSerializable.hpp
+++ b/cppcache/include/geode/PdxSerializable.hpp
@@ -34,6 +34,9 @@ namespace client {
 class PdxReader;
 class PdxWriter;
 
+/**
+ * An interface for objects whose state can be written/read as PDX.
+ */
 class APACHE_GEODE_EXPORT PdxSerializable : public virtual Serializable,
                                             public virtual CacheableKey {
  public:
diff --git a/cppcache/include/geode/Serializable.hpp b/cppcache/include/geode/Serializable.hpp
index 7ed090f..26e6baa 100644
--- a/cppcache/include/geode/Serializable.hpp
+++ b/cppcache/include/geode/Serializable.hpp
@@ -47,7 +47,7 @@ using TypeFactoryMethodPdx = std::function<std::shared_ptr<PdxSerializable>()>;
 
 /**
  * @class Serializable Serializable.hpp
- * This abstract base class is the superclass of all user objects
+ * This base class is the superclass of all user objects
  * in the cache that can be serialized.
  */
 class APACHE_GEODE_EXPORT Serializable {
diff --git a/cppcache/include/geode/TypeRegistry.hpp b/cppcache/include/geode/TypeRegistry.hpp
index 48ca614..32b1815 100644
--- a/cppcache/include/geode/TypeRegistry.hpp
+++ b/cppcache/include/geode/TypeRegistry.hpp
@@ -32,6 +32,11 @@ namespace client {
 class CacheImpl;
 class PdxSerializer;
 
+/**
+ * Registry for custom serializable types, both PDXSerializable and
+ * DataSerializable.
+ *
+ */
 class APACHE_GEODE_EXPORT TypeRegistry {
  public:
   explicit TypeRegistry(CacheImpl* cache);


Mime
View raw message