Document Esclipse Store/Serializer apis #604
Description
Is your feature request related to a problem? Please describe.
@fh-ms @hg-ms
I wanted to develop a "eclipse store browser" for inspecting stored entities, that can be easily embedded in my apps . I know there is one, but it comes with way too much baggage I did not want - Spring/Vaadin/Rest.
I managed to get the whole browser in a single java file (see attached) but it was very painful process, because none of these apis are documented:
import org.eclipse.serializer.persistence.binary.types.BinaryFieldLengthResolver;
import org.eclipse.serializer.persistence.types.*;
import org.eclipse.serializer.reflect.ClassLoaderProvider;
import org.eclipse.store.storage.restadapter.types.StorageRestAdapter;
import org.eclipse.store.storage.restadapter.types.ViewerChannelStatistics;
import org.eclipse.store.storage.restadapter.types.ViewerFileStatistics;
import org.eclipse.store.storage.restadapter.types.ViewerObjectDescription;Basically I had to stare at the debugger and guess what all these attribute mean. I am not even sure if "generateHtml" and "generateReferenceHtml" work properly (see attached file)
Describe the solution you'd like
Add good javadocs. Not only this helps developers, but AI code assistants also benefit a lot from such comments to understand the design and purpose of the code.
Additional context
Attached is 1-file db browser, mostly build by "guessing from thing showing in the debugger":