[boost] Re: Formal review: serialization

From: David Abrahams (dave_at_[hidden])
Date: 2004-04-21 06:10:11

Vladimir Prus <ghost_at_[hidden]> writes:

> However, there's code that user calls, and I'd like to see docs for that,
> too.
>
> For example:
>
>    binary_object make_binary_object(void* ptr, unsigned size);
>    Returns: binary_object(ptr, size);
>
>    binary_object::save(Archive& ar, unsigned version)
>    Effects: Calls ar.save_binary(m_ptr, m_size);
>
>    binary_object::load(Archive& ar, unsigned version)
>    Effects: Calls ar.load_binary(m_ptr, m_size);
>
> That's boring, but makes the semantic 100% clear.

Yes, and IMO that sort of documentation is absolutely a minimal
requirement for any Boost library.  Those that don't have it need to
be fixed.

-- 
Dave Abrahams
Boost Consulting
http://www.boost-consulting.com