Update of /cvsroot/pclasses/pclasses2/src/s11n
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7948/src/s11n
Modified Files:
S11nNode.h
Log Message:
Added some API docs.
Index: S11nNode.h
===================================================================
RCS file: /cvsroot/pclasses/pclasses2/src/s11n/S11nNode.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- S11nNode.h 28 Dec 2004 04:14:37 -0000 1.1
+++ S11nNode.h 28 Dec 2004 16:05:15 -0000 1.2
@@ -8,6 +8,24 @@
namespace P { namespace SIO {
+ /**
+ The concrete "data node" type used by serialization operations.
+
+ Note that it is considered poor form to use an S11nNode's
+ API directly, as it's type and interface may change. The
+ only guaranty the SIO API gives regarding S11nNode's API is
+ that NodeTraits::funcname(S11nNode &...) operations will work
+ as expected/documented. More clearly: use NodeTraits to
+ manipulate and query nodes, not the node API directly. In
+ fact S11nNode's useful API is all private, so you CAN'T
+ touch it without going through NodeTraits. :) Gotcha!
+
+ The API for this class is documented in
+ P::Util::SimplePropertyStore. The conventions for it's
+ use in s11n are defined in the s11n library manual
+ (http://s11n.net/download/).
+
+ */
class S11nNode : public ::P::Util::SimplePropertyStore
{
public:
|
