Git-Mirrors/RetroShare
1
0
Fork 0
mirror of https://github.com/RetroShare/RetroShare.git synced 2024-12-28 08:59:37 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Remove outdated documentation

Browse Source
This commit is contained in:
Gioacchino Mazzurco 2018-01-27 18:39:17 +01:00
parent 8b774595d7
commit ef6681b6f9
2 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
libretroshare/src/rsitems/rsitem.h
View File

@ -75,7 +75,7 @@ struct RsItem : RsMemoryManagement::SmallObject, RsSerializable
/** /**
* TODO: This default implementation should be removed and childs structs * 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 * the new serialization system
*/ */
virtual void serial_process(RsGenericSerializer::SerializeJob, virtual void serial_process(RsGenericSerializer::SerializeJob,

7
libretroshare/src/serialiser/rsserializable.h
View File

@ -23,13 +23,10 @@
/** @brief Minimal ancestor for all serializable structs in RetroShare. /** @brief Minimal ancestor for all serializable structs in RetroShare.
* If you want your struct to be easly serializable you should inherit from this * If you want your struct to be easly serializable you should inherit from this
* struct. * struct.
* If you want your struct to be serializable as part of a container like an
* `std::vector<T>` @see RS_REGISTER_SERIALIZABLE_TYPE_DEF(T) and
* @see RS_REGISTER_SERIALIZABLE_TYPE_DECL(T)
*/ */
struct RsSerializable 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) * the helper macro @see RS_SERIAL_PROCESS(I)
*/ */
virtual void serial_process(RsGenericSerializer::SerializeJob j, virtual void serial_process(RsGenericSerializer::SerializeJob j,
@ -37,7 +34,7 @@ struct RsSerializable
}; };
/** @def RS_SERIAL_PROCESS(I) /** @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)` * processing inside `YourSerializable::serial_process(j, ctx)`
* *
* Pay special attention for member of enum type which must be declared * Pay special attention for member of enum type which must be declared