Boost logo

Boost :

From: David Abrahams (dave_at_[hidden])
Date: 2003-09-21 07:58:02


Beman Dawes <bdawes_at_[hidden]> writes:

> How about this form (using a filesystem library example):
>
> // boost/filesystem/path.hpp -----------------------------------------//
>
> // Copyright Beman Dawes 2002. Use, modification and distribution is
> // subject to the Boost Software License Version 1.0. (See accompanying
> // file LICENSE-1.0 or http://www.boost.org/LICENSE-1.0)
>
> // See http://www.boost.org/libs/filesystem for documentation.
>
> Is that OK?

I like it. I still want to drop "the".

> What should the wording associated with the library URL be? "See ...
> for documentation." doesn't seem quite right. The docs at that URL may
> be for a later version. The point is to direct people to the library's
> home page, particularly if they are looking at a file which has become
> separated from its documentation or is out-of-date.
>
> // See http://www.boost.org/libs/filesystem for library home page.
>
> Would that be better?

What I've normally seen is something like

// See http://www.boost.org/libs/filesystem for this library's current
// version and documentation

-- 
Dave Abrahams
Boost Consulting
www.boost-consulting.com

Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk