2009/5/31 Daniel James <daniel_james@fmail.co.uk>:
2009/5/31 Sebastian Redl <sebastian.redl@getdesigned.at>:
Daniel James wrote:
I'd like to change the guideline for writing reference documentation to include header and namespace information in the detailed documentation. If you arrive at a page by a link or from a search engine, it isn't always easy to work this out. I'll add them to the list here:
http://www.boost.org/doc/libs/release/more/writingdoc/structure.html#detaile...
Boostbook documentation already includes this. Any objections?
Oh, I've got an objection myself. That part of the document concerns the C++ standard documentation guidelines, where this isn't appropriate. So instead I added an extra paragraph to the introduction: https://svn.boost.org/trac/boost/changeset/53551/trunk https://svn.boost.org/svn/boost/trunk/more/writingdoc/structure.html#introdu... Feel free to suggest changes, content, style, grammar or anything else. I don't harbour any illusions about my ability as a writer. Daniel