Re: [boost] [Logging] Documentation comments.

From: Scott Woods (scott.suzuki_at_[hidden])
Date: 2008-02-11 13:02:36

Hi John,

Yet another suggestion.

Documentation that was structured something like;

* Overview Of A Configurable Logging Facillity
* Canned Configurations
    * Just Using A File
    * In The Presence Of An IDE
    * Sending To Syslog
    * ...
* The Default Configuration
* Advanced Configuration

While the configurability of your library is perhaps its greatest selling
point, without the bundling of "kickstart" code and a presentation such
as that shown above it forces first timers to learn how to configure. I
remember clicking your "Fast And Furious" with a mixture of guilt and
relief only to be faced with material that still assumed a deeper 
understanding.

There is an analogy to be drawn with the STL. I was a wary adopter of 
strings
and maps, only using them in the simplest ways. Documentation for such usage
was plentiful. But it's the deeper potential of these STL templates that has 
made
me a convert.

Cheers.