Re: [boost] [Logging] Documentation comments.

From: John Torjo (john.groups_at_[hidden])
Date: 2008-02-11 15:58:36

Hi Scott,
> 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
>
>   
Ok, that sounds doable - after redesigning the lib, I'll do my best to 
do it like this.
> 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
>   
I guess I just didn't realize how important a few lines of code really 
are :)
> 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.
>   
Ok, point taken.
> 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.
>
>   
Ok, you'll have it in the next version.

Best,
John
> Cheers.
>
> _______________________________________________
> Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
>
>   

-- 
http://John.Torjo.com -- C++ expert
http://blog.torjo.com
... call me only if you want things done right