[Boost-docs] [boostbook] Paragraphs in purpose tags

From: Daniel James (daniel_james_at_[hidden])
Date: 2007-06-20 18:46:30

Hi,

It seems that in boostbook code, <purpose> shouldn't really contain 
paragraphs, but in quite a few cases they do which leads to paragraphs 
inside paragraphs in some of the generated documentation. For an 
example, see:

http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/boost/any_cast.html

which contains the invalid code:

<p>boost::any_cast &#8212; <p>Custom keyword cast for extracting a value
           of a given type from an
           <tt class="computeroutput"><a href="any.html" title="Class 
any">any</a></tt>.</p></p>

This is invalid because <p> tags can't be nested. There are lots of 
other examples of the same problem.

The funny thing is that boostbook already contains code for stripping 
the paragraphs out - but it doesn't get called. Does anyone know if 
there's a reason for this? Maybe to give authors more control over the 
generated documentation...

Anyway, I've attached a patch which turns it on in this case, I think 
there might be other places in the boostbook code where it's 
appropriate, but I haven't looked into it yet.

Does the patch look okay?

Daniel