[boost] Re: Misc library documentation issues

From: Beman Dawes (beman_at_[hidden])
Date: 1999-07-07 14:39:19

At 01:57 PM 7/7/99 -0500, Ed Brey wrote:

>Issues with the boost library documentation:
>
>On page http://www.boost.org/libs/utility/utility.htm,
>there is a spurius line break following "when you want to prohibit
>copying and".

Fixed.

>On page http://www.boost.org/libs/utility/index.htm,
>the line "Download a single ZIP file containing all the other
files."
>is misleading, although technically correct.  The zip file contains
>all the files for the utility library, not just the "other" files,
>which the wording at first implies.

Fixed, there and in a couple of other places.

(It may be a while before these fixes show up on the site.  I
upgraded from FrontPage 98 to FrontPage 2000, and am having site
update problems.)

>On page http://www.boost.org/libs/smart_ptr/scoped_ptr.htm,
>"~scoped_ptr();" does not have a throw specification, yet the
>destructor documentation says "Does not throw exceptions."
>This seems inconsistent.  Is there a good rationale for it?

Yes.  Perhaps Dave Abrahams, who developed the rationale, can give me
clear wording for the docs, but the roughly it is an efficiency
consideration - if you say throw(), the compiler may have to
internally wrap the code in a try block to ensure nothing gets
thrown.  It is not all that clear in my mind that it is ever a good
idea to say supply an empty throw specification.

--Beman

------------------------------------------------------------------------

eGroups.com home: http://www.egroups.com/group/boost
http://www.egroups.com - Simplifying group communications