Re: [boost] Synopsis Thoughts (was Re: Reference documentation)

From: David Abrahams (dave_at_[hidden])
Date: 2002-10-31 23:24:28

"William E. Kempf" <wekempf_at_[hidden]> writes:

> David Abrahams said:
> >
> > Stephen and I have been talking about ways to eliminate those details
> > for user documentation, while showing them for implementation
> > documentation. For example, Boost.Python uses some intermediate
> > classes in its hierarchy which should be "compressed away".
> 
> I can think of several solutions, not all of which would be direct
> support by Synopsis (for example, DocBook transformations to remove
> the unwanted documentation).  

It's not that the documentation should be removed. Those intermediate
classes contain some of the public interface. We want to hide the
existence of the intermediate classes, though. That doesn't seem like
an appropriate transformation to handle at the document level.

-- 
                    David Abrahams
dave_at_[hidden] * http://www.boost-consulting.com
#################################################################
#################################################################
#################################################################
#####
#####
#####
#################################################################
#################################################################
#################################################################