|
|
Boost-Commit : |
From: john.groups_at_[hidden]
Date: 2007-11-16 14:58:11
Author: jtorjo
Date: 2007-11-16 14:58:10 EST (Fri, 16 Nov 2007)
New Revision: 41157
URL: http://svn.boost.org/trac/boost/changeset/41157
Log:
[logging]
v0.11.20, 16 nov 2007
- restructured some of the docs/added more - the docs should be rather ok now
- removed sink.hpp - no need anymore
Added:
sandbox/logging/boost/logging/detail/raw_doc/miscelaneous.hpp (contents, props changed)
Removed:
sandbox/logging/boost/logging/detail/sink.hpp
Text files modified:
sandbox/logging/boost/logging/detail/raw_doc/changelog.hpp | 4 +++-
sandbox/logging/boost/logging/detail/raw_doc/fixme.hpp | 20 --------------------
sandbox/logging/boost/logging/detail/raw_doc/main.hpp | 13 +++++++++++++
sandbox/logging/boost/logging/detail/raw_doc/table_of_contents.hpp | 1 +
sandbox/logging/boost/logging/detail/scenario.hpp | 10 +++++-----
sandbox/logging/boost/logging/detail/use_format_write.hpp | 8 ++++----
sandbox/logging/boost/logging/gather/ostream_like.hpp | 2 ++
sandbox/logging/boost/logging/tags.hpp | 2 +-
sandbox/logging/lib/logging/internal/vc8/loggingvc8/loggingvc8.vcproj | 6 +++++-
9 files changed, 34 insertions(+), 32 deletions(-)
Modified: sandbox/logging/boost/logging/detail/raw_doc/changelog.hpp
==============================================================================
--- sandbox/logging/boost/logging/detail/raw_doc/changelog.hpp (original)
+++ sandbox/logging/boost/logging/detail/raw_doc/changelog.hpp 2007-11-16 14:58:10 EST (Fri, 16 Nov 2007)
@@ -1,7 +1,9 @@
/**
@page page_changelog Changelog
-_at_section changelog_cur_ver Current Version: v0.11.18, 16 nov 2007
+@section changelog_cur_ver Current Version: v0.11.20, 16 nov 2007
+- restructured some of the docs/added more - the docs should be rather ok now
+- removed sink.hpp - no need anymore
- removed old_examples
- removed do_not_use tests
- more changes in the documentation ; also "refactored" table of contents
Modified: sandbox/logging/boost/logging/detail/raw_doc/fixme.hpp
==============================================================================
--- sandbox/logging/boost/logging/detail/raw_doc/fixme.hpp (original)
+++ sandbox/logging/boost/logging/detail/raw_doc/fixme.hpp 2007-11-16 14:58:10 EST (Fri, 16 Nov 2007)
@@ -1,26 +1,6 @@
/*
-
-FIXME
-all gather classes - they need to typedef the param they take, so that I can create a virtual function.
-no more process_msg class -> remove from docs!
-gathering the message - gather class must hold "param" type!
-gather namespace - rewrite docs
-update namespace_concepts - I have scenario/tags/ etc!
-tell about logger_format_write <> - in format_write<> as well
-
-
-------> FIXME after showing scenarios, show customizing?
-
-
-
-
-
-
-
-about process_msg
-about macros - macros.hpp -> have specific page
about non_const_context
about formatting
Modified: sandbox/logging/boost/logging/detail/raw_doc/main.hpp
==============================================================================
--- sandbox/logging/boost/logging/detail/raw_doc/main.hpp (original)
+++ sandbox/logging/boost/logging/detail/raw_doc/main.hpp 2007-11-16 14:58:10 EST (Fri, 16 Nov 2007)
@@ -5,6 +5,7 @@
- @ref main_motivation
- @ref main_common_usage
+- @ref main_feeback
- @ref page_changelog
@section main_motivation Motivation
@@ -53,10 +54,22 @@
\n\n\n
+@section main_feeback Feedback
+
+I certainly welcome all feedback. So, be it a suggestion, or criticism, do write to me:
+- contact me: http://torjo.com/contact.html
+- If there's a feature you'd like, you can contact me, or drop a comment here:
+ http://torjo.blogspot.com/2007/11/boost-logging-v2-your-killer-feature.html \n
+ (this way, others can contribute with comments as well)
+
+
+\n\n\n
@section main_changelog Changelog
@ref page_changelog "See the changelog".
+
+
*/
}}
Added: sandbox/logging/boost/logging/detail/raw_doc/miscelaneous.hpp
==============================================================================
--- (empty file)
+++ sandbox/logging/boost/logging/detail/raw_doc/miscelaneous.hpp 2007-11-16 14:58:10 EST (Fri, 16 Nov 2007)
@@ -0,0 +1,20 @@
+namespace boost { namespace logging {
+
+/**
+@page miscelaneous Miscelaneous things
+
+@section misc_use_defaults Template parameters - Using defaults
+
+This parameter is optional. This means you don't need to set it, unless you want to.
+Just leave it as @c default_, and move on to the paramers you're interested in.
+
+Example:
+
+@code
+typedef logger_format_write< default_, default_, writer::threading::on_dedicated_thread > log_type;
+@endcode
+
+
+*/
+
+}}
Modified: sandbox/logging/boost/logging/detail/raw_doc/table_of_contents.hpp
==============================================================================
--- sandbox/logging/boost/logging/detail/raw_doc/table_of_contents.hpp (original)
+++ sandbox/logging/boost/logging/detail/raw_doc/table_of_contents.hpp 2007-11-16 14:58:10 EST (Fri, 16 Nov 2007)
@@ -6,6 +6,7 @@
- @ref main_intro
- @ref main_motivation
+ - @ref main_feeback
- @ref page_changelog
- @ref changelog_cur_ver
- @ref acknowledgements
Modified: sandbox/logging/boost/logging/detail/scenario.hpp
==============================================================================
--- sandbox/logging/boost/logging/detail/scenario.hpp (original)
+++ sandbox/logging/boost/logging/detail/scenario.hpp 2007-11-16 14:58:10 EST (Fri, 16 Nov 2007)
@@ -393,11 +393,11 @@
For this to happen, you will first need to specify your needs (the template parameters you'll pass to this class)
- @param filter_change (optional) How does the %filter change? Any of the classes in the filter_::change namespace
- @param filter_level_ (optional) Does our %filter %use levels? Any of the classes in the filter_::level namespace
- @param logger_change (optional) How does our %logger change? Any of the classes in the logger_::change namespace
- @param logger_favor (optional) What does the %logger favor? Any of the classes in the logger_::favor namespace
- @param logger_gather (optional) What to %use as gather class. Any of the classes in the logger_::gather namespace
+ @param filter_change @ref misc_use_defaults "(optional)" How does the %filter change? Any of the classes in the filter_::change namespace
+ @param filter_level_ @ref misc_use_defaults "(optional)" Does our %filter %use levels? Any of the classes in the filter_::level namespace
+ @param logger_change @ref misc_use_defaults "(optional)" How does our %logger change? Any of the classes in the logger_::change namespace
+ @param logger_favor @ref misc_use_defaults "(optional)" What does the %logger favor? Any of the classes in the logger_::favor namespace
+ @param logger_gather @ref misc_use_defaults "(optional)" What to %use as gather class. Any of the classes in the logger_::gather namespace
@copydoc your_scenario_examples
*/
Deleted: sandbox/logging/boost/logging/detail/sink.hpp
==============================================================================
--- sandbox/logging/boost/logging/detail/sink.hpp 2007-11-16 14:58:10 EST (Fri, 16 Nov 2007)
+++ (empty file)
@@ -1,85 +0,0 @@
-// sink.hpp
-
-// Boost Logging library
-//
-// Author: John Torjo, www.torjo.com
-//
-// Copyright (C) 2007 John Torjo (see www.torjo.com for email)
-//
-// Distributed under the Boost Software License, Version 1.0.
-// (See accompanying file LICENSE_1_0.txt or copy at
-// http://www.boost.org/LICENSE_1_0.txt)
-//
-// See http://www.boost.org for updates, documentation, and revision history.
-// See http://www.torjo.com/log2/ for more details
-
-/* FIXME this whole file will most likely dissapear
-
-*/
-
-#ifndef JT28092007_sink_HPP_DEFINED
-#define JT28092007_sink_HPP_DEFINED
-
-#if defined(_MSC_VER) && (_MSC_VER >= 1020)
-# pragma once
-#endif
-
-#include <boost/logging/detail/fwd.hpp>
-
-namespace boost { namespace logging {
-
-
-
- /*
- The sink
-
- Workflow - we have a sink object, which asks the logger if it's enabled
- If the logger is enabled, it also returns the message processor.
-
- Thus, you can write code like this:
- if ( sink<some_type> s = find_logger(some_logger) )
- s.process_msg( ... );
-
- Note that this is useful only if you have a find_logger function which doesn't always return the same logger
- (thus, you need to cached the result).
-
- Otherwise, the logger already has helper funcs, which allow you to do this:
-
- if ( logger) logger.process_msg()....
- */
- template<class process_msg_type> struct sink {
- template<class logger> sink(const logger & f) {
- p = f.is_enabled() ? &f.process_msg() : 0;
- }
- operator bool() const { return p != 0; }
- const process_msg_type & process_msg() { return *p; }
- /**
- Syntactic sugar. Allow writing
- if ( sink s = dbg_filter) s->some_func(x);
- */
- const process_msg_type* operator->() { return p; }
- protected:
- const process_msg_type * p;
- };
-
- /**
- This negates the sink, allowing you to create LOG macros. That is, it allows for this construct:
-
- if ( negate_sink<some_type> s = find_logger(some_filter) )
- ;
- else
- s.process_msg() ...;
-
- @sa sink
- */
- template<class process_msg_type> struct negate_sink : sink<process_msg_type> {
- typedef sink<process_msg_type> base_type;
- template<class logger> negate_sink(const logger & f) : base_type(f) {}
- operator bool() const { return base_type::p == 0; }
- };
-
-}}
-
-
-#endif
-
Modified: sandbox/logging/boost/logging/detail/use_format_write.hpp
==============================================================================
--- sandbox/logging/boost/logging/detail/use_format_write.hpp (original)
+++ sandbox/logging/boost/logging/detail/use_format_write.hpp 2007-11-16 14:58:10 EST (Fri, 16 Nov 2007)
@@ -123,10 +123,10 @@
FIXME need to have more template params
-_at_param format_base_type your formatter base class
-_at_param destination_base your destination base class
-_at_param thread_safety
-_at_param gather
+@param format_base_type @ref misc_use_defaults "(optional)" Your formatter base class
+@param destination_base @ref misc_use_defaults "(optional)" Your destination base class
+@param thread_safety @ref misc_use_defaults "(optional)" Thread-safety. Any of the writer::threading classes.
+@param gather @ref misc_use_defaults "(optional)" The class that @ref gather "gathers" the message
*/
template<class format_base, class destination_base, class thread_safety, class gather, class lock_resource>
struct logger_format_write
Modified: sandbox/logging/boost/logging/gather/ostream_like.hpp
==============================================================================
--- sandbox/logging/boost/logging/gather/ostream_like.hpp (original)
+++ sandbox/logging/boost/logging/gather/ostream_like.hpp 2007-11-16 14:58:10 EST (Fri, 16 Nov 2007)
@@ -33,6 +33,8 @@
A class that implements gathering the message needs 2 things:
- a function that will gather the data - called <tt>.out()</tt>
- define a function called <tt>.msg()</tt> that will return the gathered data (once all data has been gathered).
+- have a public type named "param" - be it a class or a typedef
+ - this contains what the gather_msg class return
*/
Modified: sandbox/logging/boost/logging/tags.hpp
==============================================================================
--- sandbox/logging/boost/logging/tags.hpp (original)
+++ sandbox/logging/boost/logging/tags.hpp 2007-11-16 14:58:10 EST (Fri, 16 Nov 2007)
@@ -233,7 +233,7 @@
/** @brief Holds up to 10 @ref tag "tags".
-_at_param string_ The string class we use for holding logged messages. By default, std::(w)string. What you used to specify using BOOST_LOG_FORMAT_MSG.
+@param string_ (required) The string class we use for holding logged messages. By default, std::(w)string. What you used to specify using BOOST_LOG_FORMAT_MSG.
@param param1 (optional) First tag
@param param2 (optional) Second tag
Modified: sandbox/logging/lib/logging/internal/vc8/loggingvc8/loggingvc8.vcproj
==============================================================================
--- sandbox/logging/lib/logging/internal/vc8/loggingvc8/loggingvc8.vcproj (original)
+++ sandbox/logging/lib/logging/internal/vc8/loggingvc8/loggingvc8.vcproj 2007-11-16 14:58:10 EST (Fri, 16 Nov 2007)
@@ -430,7 +430,7 @@
>
</File>
<File
- RelativePath="..\..\..\..\..\boost\logging\process_msg\ostream_like.hpp"
+ RelativePath="..\..\..\..\..\boost\logging\gather\ostream_like.hpp"
>
</File>
<File
@@ -674,6 +674,10 @@
>
</File>
<File
+ RelativePath="..\..\..\..\..\boost\logging\detail\raw_doc\miscelaneous.hpp"
+ >
+ </File>
+ <File
RelativePath="..\..\..\..\..\boost\logging\detail\raw_doc\namespace_concepts.hpp"
>
</File>
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk