[
https://issues.apache.org/jira/browse/GEODE-5919?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Michael Martell updated GEODE-5919:
-----------------------------------
Description:
This ticket is to fix documentation bugs in the cppcache portion of the native
client API. Specifically, comments for the following classes need to be fixed.
*CPPCACHE*
apache::geode::client::CacheableUndefined (uncommented)
apache::geode::client::CacheTransactionManager (uncommented)
apache::geode::client::PdxSerializable (uncommented)
apache::geode::client::TypeRegistry (uncommented)
apache::geode::client::CacheableEnum (comment in wrong place, not picked up)
apache::geode::client::CacheableObjectArray (comment in wrong place, not picked
up)
apache::geode::client::CacheableFileName (comment in wrong place, not picked up)
apache::geode::client::Delta (comment in wrong place, not picked up)
apache::geode::client::EntryEvent (comment in wrong place, not picked up)
apache::geode::client::AuthenticatedView (wrong comment, called Cache class)
DataSerializableFixedId_t (uncommented, but is exported, but is internal so
maybe shouldn't be exported)
DataSerializableInternal (uncommented, but is exported, but is internal so
maybe shouldn't be exported)
DataSerializablePrimitive (uncommented, but is exported, but is internal so
maybe shouldn't be exported)
*CLICACHE*
Apache::Geode::Client::IDataSerializable
Apache::Geode::Client::TypeRegistry
was:
This ticket is to fix documentation bugs in the cppcache portion of the geode
native API. Specifically, comments for the following classes need to be fixed.
These are doxygen fixes.
apache::geode::client::CacheableUndefined (uncommented)
apache::geode::client::CacheTransactionManager (uncommented)
apache::geode::client::PdxSerializable (uncommented)
apache::geode::client::TypeRegistry (uncommented)
apache::geode::client::CacheableEnum (comment in wrong place, not picked up)
apache::geode::client::CacheableObjectArray (comment in wrong place, not
picked up)
apache::geode::client::CacheableFileName (comment in wrong place, not picked
up)
apache::geode::client::Delta (comment in wrong place, not picked up)
apache::geode::client::EntryEvent (comment in wrong place, not picked up)
apache::geode::client::AuthenticatedView (wrong comment, called Cache class)
DataSerializableFixedId_t (uncommented, but is exported, but is internal so
maybe shouldn't be exported)
DataSerializableInternal (uncommented, but is exported, but is internal so
maybe shouldn't be exported)
DataSerializablePrimitive (uncommented, but is exported, but is internal so
maybe shouldn't be exported)
> Fix Documentation Bugs in Geode Native public APIs
> --------------------------------------------------
>
> Key: GEODE-5919
> URL: https://issues.apache.org/jira/browse/GEODE-5919
> Project: Geode
> Issue Type: Bug
> Components: native client
> Reporter: Michael Martell
> Priority: Major
>
> This ticket is to fix documentation bugs in the cppcache portion of the
> native client API. Specifically, comments for the following classes need to
> be fixed.
> *CPPCACHE*
> apache::geode::client::CacheableUndefined (uncommented)
> apache::geode::client::CacheTransactionManager (uncommented)
> apache::geode::client::PdxSerializable (uncommented)
> apache::geode::client::TypeRegistry (uncommented)
> apache::geode::client::CacheableEnum (comment in wrong place, not picked up)
> apache::geode::client::CacheableObjectArray (comment in wrong place, not
> picked up)
> apache::geode::client::CacheableFileName (comment in wrong place, not picked
> up)
> apache::geode::client::Delta (comment in wrong place, not picked up)
> apache::geode::client::EntryEvent (comment in wrong place, not picked up)
> apache::geode::client::AuthenticatedView (wrong comment, called Cache class)
> DataSerializableFixedId_t (uncommented, but is exported, but is internal so
> maybe shouldn't be exported)
> DataSerializableInternal (uncommented, but is exported, but is internal so
> maybe shouldn't be exported)
> DataSerializablePrimitive (uncommented, but is exported, but is internal so
> maybe shouldn't be exported)
> *CLICACHE*
> Apache::Geode::Client::IDataSerializable
> Apache::Geode::Client::TypeRegistry
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
