update comment

This commit is contained in:
David Rose 2002-06-18 18:27:13 +00:00
parent 6274a02610
commit 89af39b692
2 changed files with 9 additions and 7 deletions

View File

@ -399,8 +399,10 @@ read_handle(DatagramIterator &scan) {
// Description: The interface for reading a pointer to another object // Description: The interface for reading a pointer to another object
// from a Bam file. Objects reading themselves from a // from a Bam file. Objects reading themselves from a
// Bam file should call this when they expect to read a // Bam file should call this when they expect to read a
// pointer, passing in the datagram iterator and a // pointer to some other object. This function reads
// pointer to their own object, i.e. 'this'. // whatever is stored in the bam file to represent the
// pointer, and advances the datagram iterator
// accordingly.
// //
// Rather than returning a pointer immediately, this // Rather than returning a pointer immediately, this
// function reads the internal pointer information from // function reads the internal pointer information from

View File

@ -254,11 +254,11 @@ write_cdata(Datagram &packet, const PipelineCyclerBase &cycler) {
// //
// The writing object should call this prior to writing // The writing object should call this prior to writing
// out a PointerToArray. It will return true if the // out a PointerToArray. It will return true if the
// same pointer has been previously, in which case the // same pointer has been written previously, in which
// writing object need do nothing further; or it will // case the writing object need do nothing further; or
// return false if this particular pointer has not yet // it will return false if this particular pointer has
// been written, in which case the writing object must // not yet been written, in which case the writing
// then write out the contents of the array. // object must then write out the contents of the array.
// //
// Also see the WRITE_PTA() macro, which consolidates // Also see the WRITE_PTA() macro, which consolidates
// the work that must be done to write a PTA. // the work that must be done to write a PTA.