On Sep 29, 2004, at 10:41 AM, Eric Niebler wrote:
Jeff Garland wrote:On Wed, 29 Sep 2004 13:18:44 +0400, Vladimir Prus wroteI'm I'm looking for a specific class or function, that reference is very hard to use. First, it's organised by header, and the header where a symbols is defined is secondary information for almost every userI agree totally with this, but header based documentation has been the boost
way -- so we are fighting against tradition.
IMO, it's a tradition that should change. I agree completely with Volodya and Jeff.
IMHO, header-based documentation makes sense for course-grained headers, but not for fine-grained headers. The C++ standard has course-grained headers, and I think it works relatively well to use header-based documentation. But once glance at the library reference for Date-Time shows how the header-based documentation system really breaks down with fine-grained headers.
One alternative is to combine the synopsis from each header into a single synopsis for the library, and then add a "Where Defined" section to each reference page (as in the Graph library). Arbitrary groupings could come later. Just be warned that I have zero time to work on this for at least the next week and a half, so this is definitely post-1.32.0.
Doug
------------------------------------------------------- This SF.net email is sponsored by: IT Product Guide on ITManagersJournal Use IT products in your business? Tell us what you think of them. Give us Your Opinions, Get Free ThinkGeek Gift Certificates! Click to find out more http://productguide.itmanagersjournal.com/guidepromo.tmpl _______________________________________________ Boost-docs mailing list [EMAIL PROTECTED] Unsubscribe and other administrative requests: https://lists.sourceforge.net/lists/listinfo/boost-docs
