RE: [boost] Reference documentation: one approach

From: Jeff Garland (jeff_at_[hidden])
Date: 2002-10-29 18:30:53

> However, looking at your XML it looks like
> > it might be fairly easy to create something like:
> >
> >  template<typename Signature1,
> >           typename Allocator1,
> >           typename Signature2,
> >           typename Allocator2>
> >  void operator!=(const function<Signature1, Allocator1>&,
> >                  const function<Signature2, Allocator2>&);
> 
> That's fine for the example, but that method would result in some ugly 
> formatting for short names:
> 
>   template<typename T>
>   void swap(const T& t1,
>             const T& t2);
> 
> whereas we would really like:
> 
>   template<typename T> void swap(T& t1, T& t2);

I agree...
 
> I've now finished some more XSLT code to line-wrap function parameters: if the 
> parameter fits on the line, put it on the line; otherwise, indent to the 
> position where the parameters started on the first line and emit the  
> parameter. It's not done for template headers yet, but it will give the same 
> results as in your example (with long parameter names), but it will give the 
> nicer version of swap(). I'm currently working on integrating it to get a 
> full example going.

Nice -- I'm really glad you were the one that had to figure out the weird XSL 
code for that little trick!

Jeff