Re: [boost] Re: string algorithms review

From: Pavol Droba (droba_at_[hidden])
Date: 2003-10-18 08:50:44

On Sat, Oct 18, 2003 at 03:18:44PM +0200, Daniel Frey wrote:

[snip]

> >The library is layered. I assume, that you are refering to the second 
> >layer (i.e. namespace boost::string_algo). This is not a detail::-stuff. 
> >It it designed to be used by advanced users. I think, that it could be 
> >very usable,
> >and I would encourage the users to try it and use it.
> 
> No, but I guess I haven't expressed myself clearly. The return values of 
> some functions are e.g. token_finder exposes the detail::-return type 
> instead of hiding it:
> 
> template<typename PredicateT>
>   detail::token_finderF< PredicateT >
>   token_finder(PredicateT Pred, bool bCompress = true);
> 
> I think Peter Dimov provided a good alternative in his documentation in 
> those situations, where the docs contain something like 
> 'implementation-defined-type' in italics and only say what basic 
> guarantees, e.g. derived from XYZ, the result type provides instead of 
> specifying it explicitly.
> 

Ok, I see your point. Unfortunately, I don't know how to handle this problem now.
Reference documentation is generated from the sources using doxygen-boostbook and
I don't know how to change this.

But I will address this topic in the boost-doc list.

Regards,

Pavol