From ef6681b6f9c4b8bc506a59f9de0c3e92e6ceef9f Mon Sep 17 00:00:00 2001 From: Gioacchino Mazzurco Date: Sat, 27 Jan 2018 18:39:17 +0100 Subject: [PATCH] Remove outdated documentation --- libretroshare/src/rsitems/rsitem.h | 2 +- libretroshare/src/serialiser/rsserializable.h | 7 ++----- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/libretroshare/src/rsitems/rsitem.h b/libretroshare/src/rsitems/rsitem.h index fb76d1562..545870631 100644 --- a/libretroshare/src/rsitems/rsitem.h +++ b/libretroshare/src/rsitems/rsitem.h @@ -75,7 +75,7 @@ struct RsItem : RsMemoryManagement::SmallObject, RsSerializable /** * TODO: This default implementation should be removed and childs structs - * implement RsSerializable(...) as soon as all the codebase is ported to + * implement ::serial_process(...) as soon as all the codebase is ported to * the new serialization system */ virtual void serial_process(RsGenericSerializer::SerializeJob, diff --git a/libretroshare/src/serialiser/rsserializable.h b/libretroshare/src/serialiser/rsserializable.h index f55378cf1..c717afc4b 100644 --- a/libretroshare/src/serialiser/rsserializable.h +++ b/libretroshare/src/serialiser/rsserializable.h @@ -23,13 +23,10 @@ /** @brief Minimal ancestor for all serializable structs in RetroShare. * If you want your struct to be easly serializable you should inherit from this * struct. - * If you want your struct to be serializable as part of a container like an - * `std::vector` @see RS_REGISTER_SERIALIZABLE_TYPE_DEF(T) and - * @see RS_REGISTER_SERIALIZABLE_TYPE_DECL(T) */ struct RsSerializable { - /** Register struct members to serialize in this method taking advantage of + /** Process struct members to serialize in this method taking advantage of * the helper macro @see RS_SERIAL_PROCESS(I) */ virtual void serial_process(RsGenericSerializer::SerializeJob j, @@ -37,7 +34,7 @@ struct RsSerializable }; /** @def RS_SERIAL_PROCESS(I) - * Use this macro to register the members of `YourSerializable` for serial + * Use this macro to process the members of `YourSerializable` for serial * processing inside `YourSerializable::serial_process(j, ctx)` * * Pay special attention for member of enum type which must be declared