Boost C++ Libraries: Ticket #6105: Quickbook produces warnings when generating pdf

anonymous — Tue, 08 Nov 2011 18:19:03 GMT

I tried this on trunk and I didn't get any errors. Are you using a pre-built quickbook? Which version (quickbook --version)?

It looks like the errors are for the headers which link to themselves. I recently changed the boostbook representation to one suggested by John Maddock which should be better for pdfs. I'd rather not have them link to themselves at all in pdfs, it's pretty easy to implement a quickbook command line switch for that, but I'm not sure how to do the boost.build part of it.

Paul A. Bristow — Wed, 09 Nov 2011 10:31:05 GMT

Sorry I should have said - this is using the quickbook version in dev that I built to try out the 'red' option.

I think it produces these warnings for defining article quickbook 1.5 and 1.6.

So far, I haven't seen any bad effects in the actual PDF (which is why I didn't notice before).

(And the good news is that I have succesfully rebuilt several docs, including the large and heavily Doxygen commented SVG plot project).

I'll switch back to the trunk version.

Paul A. Bristow — Wed, 09 Nov 2011 12:13:19 GMT

Spoke too soon :-(

Using trunk version of Quickboook.exe and [quickbook 1.5]on the boost-sandbox/SOC/2011/checks/ docs

HTML version shows correct output of a class with template parameters described by \tparam

" ... Description

Template Parameters:

iteration_sense must meet the iteration_sense concept requirements.

number_of_virtual_value_skipped Helper functions to provide the same behavior on sequence with and without checkdigits. No "real" value in the sequence will be skipped.

... "

But PDF version shows this part (in red)as

"Description <varlistentry>Template Parameters: iteration_sense must meet the iteration_sense concept requirements. number_of_virtual_ value_skipped Helper functions to provide the same behavior on sequence with and without checkdigits. No "real" value in the sequence will be skipped. </varlistentry>

basic_check_algorithm public static functions ... "

And similarly for all template parameter section.

At least the content is present, so this is a display problem.

So there is something that I am missing?

anonymous — Wed, 09 Nov 2011 15:40:53 GMT

That's a boostbook issue. It looks like the docbook generated for class template parameters was copied from the function template parameter implementation, but classes have very different markup so it doesn't fit at all. It shouldn't be too hard to fix so I'll look into doing it later.

Daniel James — Thu, 10 Nov 2011 19:40:23 GMT

(In [75447]) Boostbook: Make the class template parameter docs fit its context. Refs #6105

Would be nice to integrate this properly with the existing template code. Especially so that the template parameters in the synopsis could link to their purpose. Also, I think the long descriptions should be suppressed when template.param.brief is true.

status changed; resolution set

Daniel James — Sun, 03 Mar 2013 14:36:29 GMT

status new → closed
resolution → fixed