[lexical-cast] Help with documentation required
I've added Qickbook documentation for lexical_cast to libs/conversion/doc/lexical_cast.qbk and a Jamfile.v2 file to build it. Meanwhile, there is an old HTML documentation for lexical_cast in libs/conversion/lexical_cast.htm and file libs/conversion/index.html references it. The question is: How shall I update the lexical_cast.htm/index.html, doc/html/ folder? Best regards, Antony Polukhin
I've built you improved docs OK Much more Boost look'n'feel :-) (though I note that the link in synopsis Library features defined in boost/lexical_cast.hpp: is broken (boost in wrong place). Would the 'best' performance be shown using bold (or italic or underline)? [table:my_table Performance [[processor] [version 1] [version 2]] [[Intel] [[_1.1]] [[*2.3]]] [[AMD] [[*2.2]] [['2.3]]] ] [/table:my_table Performance] shows these font variants in action. (Color would be even nicer ;-) - how about it Joel and Eric and Daniel? ) I note it doesn't use Doxygen, nor produce pdf version, but that may be overkill. I might be willing to help sort this out, but not just now. I suggest that you can leave it just where it is (the right place according to Boost conventions), but the main link to index.html in Boost docs, should point here rather than previous boost-trunk/libs/conversion/lexical_cast.htm HTH Paul PS Should this better be sent to boost-docs list (and copied to there)? --- Paul A. Bristow, Prizet Farmhouse, Kendal LA8 8AB UK +44 1539 561830 07714330204 pbristow@hetp.u-net.com
2011/7/20 Paul A. Bristow <pbristow@hetp.u-net.com>:
Library features defined in boost/lexical_cast.hpp:
is broken (boost in wrong place).
Fixed, thanks for the testing!
'best' performance is bold, and surrounded with '!!!'
(Color would be even nicer ;-) - how about it Joel and Eric and Daniel? )
Color would be great! It catches an eye better than bold/underlined/italic in table.
I note it doesn't use Doxygen, nor produce pdf version, but that may be overkill. I might be willing to help sort this out, but not just now.
I`ll add doxygen later. And Daniel told me that John handles the pdf generation, he usually sorts it out towards the end of the release cycle. Best regards, Antony Polukhin
On 20 July 2011 13:05, Antony Polukhin <antoshkka@gmail.com> wrote:
It's a bit awkward since lexical_cast is in some ways treated as a library in it's own right (e.g. it's included in the library list) but doesn't have its own directory. I think it's too late to change that. Since lexical_cast.htm is linked to from the library list, it's effectively lexical_cast's permanent location so it should stay and redirect to the new location (you can see examples of how to do this in most libraries' index.html files). libs/conversion/index.html should probably just be changed to link directly to the new location. You need to decide whether you want it to be included in the combined documentation, or remain standalone in the library's directory. If you let me know, I'll sort out adding it. Unless you want to check the generated documentation into subversion yourself, like some libraries do - there's been some debate on that issue in the '[fusion] html docs woes' thread. John handles the pdf generation, he usually sorts it out towards the end of the release cycle. You usually just need to check it's okay when he asks for feedback.
On 20 July 2011 16:46, Antony Polukhin <antoshkka@gmail.com> wrote:
It's done now. By the way, if you haven't seen it yet, you might be interested in this floating point conversion library: http://code.google.com/p/double-conversion/
participants (3)
-
Antony Polukhin -
Daniel James -
Paul A. Bristow