Add documentation to the serializer interfaces and remove ITypeReaderWriter #5897
+31
−23
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ElectroJr
reviewed
Apr 28, 2025
Robust.Shared/Serialization/TypeSerializers/Interfaces/ITypeSerializer.cs
Outdated
Show resolved
Hide resolved
Member
It might be leftover from an older version of serialization code? Either way its probably fine to just remove seeing as it appears to be unused. |
dffdff2423
changed the title
dffdff2423
force-pushed
the
serializationdocs
branch
from
d319001 to
28da9d2
Compare
dffdff2423
force-pushed
the
serializationdocs
branch
from
28da9d2 to
98dbe5e
Compare
PJB3005
requested changes
May 3, 2025
Robust.Shared/Serialization/Manager/Attributes/TypeSerializerAttribute.cs
Outdated
Show resolved
Hide resolved
Robust.Shared/Serialization/TypeSerializers/Interfaces/ITypeSerializer.cs
Outdated
Show resolved
Hide resolved
Robust.Shared/Serialization/TypeSerializers/Interfaces/ITypeWriter.cs
Outdated
Show resolved
Hide resolved
PJB3005
added
A: Serialization
T: Documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It took me three hours to figure out how to implement a custom serializer correctly. I think I have figured it out. This is some docs to hopefully help anybody else who is looking at this down the line.
I have no idea what the difference between ITypeSerializer and ITypeReaderWriter is so I did not include any documentation on ITypeReaderWriter. ITypeReaderWriter is not used anywhere except as a parent of ITypeSeralizer.