[
https://issues.apache.org/jira/browse/GEODE-8210?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17126817#comment-17126817
]
ASF GitHub Bot commented on GEODE-8210:
---------------------------------------
pdxcodemonkey commented on a change in pull request #612:
URL: https://github.com/apache/geode-native/pull/612#discussion_r435418278
##########
File path:
docs/geode-native-docs-cpp/serialization/cpp-serialization/pdx-serializable-examples.html.md.erb
##########
@@ -0,0 +1,165 @@
+---
+title: PdxSerializable Examples
+---
+
+<!--
+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.
+-->
+
+The native client release contains examples showing how a client application
+can register for serialization of custom objects using the C++ PdxSerializable
interface.
+
+The examples are located in `examples/cpp/pdxserializable`.
+
+The examples define the serializable class, `Orders`, including its
serialization and deserialization methods and its factory method.
+Once these pieces are in place, execution is simple: the main routine of the
example registers the serializable class then performs some put and get
operations.
+
+<a id="pdxsbl_execution"></a>
+### Execution
+
+The example performs a sequence of operations, displaying simple log entries
as they run.
Review comment:
Okay and we're using singular here
##########
File path:
docs/geode-native-docs-cpp/serialization/cpp-serialization/pdx-serializable-examples.html.md.erb
##########
@@ -0,0 +1,165 @@
+---
+title: PdxSerializable Examples
+---
+
+<!--
+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.
+-->
+
+The native client release contains examples showing how a client application
+can register for serialization of custom objects using the C++ PdxSerializable
interface.
+
+The examples are located in `examples/cpp/pdxserializable`.
+
+The examples define the serializable class, `Orders`, including its
serialization and deserialization methods and its factory method.
+Once these pieces are in place, execution is simple: the main routine of the
example registers the serializable class then performs some put and get
operations.
+
+<a id="pdxsbl_execution"></a>
+### Execution
+
+The example performs a sequence of operations, displaying simple log entries
as they run.
+
+- To run an example, follow the instructions in the README.md file in the
example directory.
Review comment:
Probably "the" example, not "an"
##########
File path:
docs/geode-native-docs-cpp/serialization/cpp-serialization/pdx-serializable-examples.html.md.erb
##########
@@ -0,0 +1,165 @@
+---
+title: PdxSerializable Examples
+---
+
+<!--
+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.
+-->
+
+The native client release contains examples showing how a client application
+can register for serialization of custom objects using the C++ PdxSerializable
interface.
Review comment:
This is a single example, right? Not 'examples', plural?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Geode-native C++ user guide: update serialization description
> -------------------------------------------------------------
>
> Key: GEODE-8210
> URL: https://issues.apache.org/jira/browse/GEODE-8210
> Project: Geode
> Issue Type: Improvement
> Components: docs
> Reporter: Dave Barnes
> Assignee: Dave Barnes
> Priority: Major
>
> Update the Geode-native C++ user guide so its serialization description
> (almost) matches the one in the .NET guide. The primary difference is that
> C++ does not support auto-serialization.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
