PR# 5181 Documentation of classes
Problem Report Summary
Submitter: andersoxie
Category: Documentation
Priority: High
Date: 2005/07/15
Class: Bug
Severity: Serious
Number: 5181
Release: 5.5.1012
Confidential: No
Status: Open
Responsible:
Environment: Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)
Synopsis: Documentation of classes
Description
Hej IO think you need to improvce the docuemntaion of your classes. For example in the 5.6 Release Candidate there is a cluster "serialization". I can not find any documentation about the new cluster. I think that the following information would be very helpfull for users of different clusters: 1. The purpose of the cluster. Description of use etc in more general terms. Why shold I use it instead of building my own classes. During which circumstances will it help me. 2. Small example of how to use the clases in a simple case. 3. A more comprehensive example. In this paricular case I would also like to see a comparsion to the STORABLE class which seems to have a similar purpose. But there are differences like the set_new_recoverable_format in STORABLE (at least i did not find it in the serialization cluster) and the read_header etc (see below) features in the SED_READER_WRITER class that seems to be interesting for my purpose which I can not find in the STORABLE class. read_header is -- Action being executed before starting to read data. do end write_header is -- Action being executed before starting to write data. do end read_footer is -- Action being executed after finishing to read data. do end write_footer is -- Action being executed after finishing to write data. do end Regards Anders Persson
To Reproduce
Problem Report Interactions