|
|
Boost-Commit : |
From: grafikrobot_at_[hidden]
Date: 2007-11-29 12:25:47
Author: grafik
Date: 2007-11-29 12:25:46 EST (Thu, 29 Nov 2007)
New Revision: 41464
URL: http://svn.boost.org/trac/boost/changeset/41464
Log:
Update documentation info for libraries.
Text files modified:
website/public_html/beta/common/menu-doc.html | 33 -----
website/public_html/beta/libraries.xml | 205 +++++++++++++++++++++++++++------------
2 files changed, 144 insertions(+), 94 deletions(-)
Modified: website/public_html/beta/common/menu-doc.html
==============================================================================
--- website/public_html/beta/common/menu-doc.html (original)
+++ website/public_html/beta/common/menu-doc.html 2007-11-29 12:25:46 EST (Thu, 29 Nov 2007)
@@ -6,7 +6,10 @@
<a href="/doc/libs">Libraries <span class="link">></span></a>
<ul>
- <li><a href="/doc/libs/1_34_0">1.34.0 - Current Release <span class=
+ <li><a href="/doc/libs/1_34_0">1.34.1 - Current Release <span class=
+ "link">></span></a></li>
+
+ <li><a href="/doc/libs/1_34_0">1.34.0 <span class=
"link">></span></a></li>
<li><a href="/doc/libs/1_33_1">1.33.1 <span class=
@@ -19,32 +22,4 @@
"link">></span></a></li>
</ul>
</li>
-<!--
- <li>
- Wiki >
-
- <ul>
- <li><a href="/doc/wiki/RecentChanges">Recent Changes <span class=
- "link">></span></a></li>
-
- <li><a href="/doc/wiki/?action=editprefs">Preferences <span class=
- "link">></span></a></li>
-
- <li><a href="/doc/wiki/?action=index">Page List <span class=
- "link">></span></a></li>
-
- <li><a href="/doc/wiki/?action=links">Links List <span class=
- "link">></span></a></li>
-
- <li id="wiki-edit"><a href="?action=edit">Edit <span class=
- "link">></span></a></li>
-
- <li id="wiki-history"><a href="?action=history">History <span class=
- "link">></span></a></li>
- </ul>
- </li>
-
- <li><a href="/common/code/webnotes/login_page.php">Webnotes Login
- <span class="link">></span></a></li>
--->
</ul>
Modified: website/public_html/beta/libraries.xml
==============================================================================
--- website/public_html/beta/libraries.xml (original)
+++ website/public_html/beta/libraries.xml 2007-11-29 12:25:46 EST (Thu, 29 Nov 2007)
@@ -68,8 +68,12 @@
<boost-version>1.25.0</boost-version>
<name>Bind</name>
<authors>Peter Dimov</authors>
- <description>Generalized binders for function/object/pointers
- and member functions.</description>
+ <description>boost::bind is a generalization of the standard
+ functions std::bind1st and std::bind2nd. It supports arbitrary
+ function objects, functions, function pointers, and member
+ function pointers, and is able to bind any argument to a
+ specific value or route input arguments into arbitrary
+ positions.</description>
<documentation>libs/bind/bind.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -159,7 +163,10 @@
<boost-version>1.22.0</boost-version>
<name>CRC</name>
<authors>Daryle Walker</authors>
- <description>Cyclic Redundancy Code.</description>
+ <description>The Boost CRC Library provides two implementations
+ of CRC (cyclic redundancy code) computation objects and two
+ implementations of CRC computation functions. The
+ implementations are template-based.</description>
<documentation>libs/crc/index.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -171,7 +178,8 @@
<boost-version>1.29.0</boost-version>
<name>Date Time</name>
<authors>Jeff Garland</authors>
- <description>Date-Time library.</description>
+ <description>A set of date-time libraries based on generic
+ programming concepts.</description>
<documentation>doc/html/date_time.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -179,27 +187,33 @@
<autolink>false</autolink>
</library>
<library>
- <key>dynamic_bitset</key>
- <boost-version>1.29.0</boost-version>
- <name>Dynamic Bitset</name>
- <authors>Jeremy Siek and Chuck Allison</authors>
- <description>A runtime sized version of
- std::bitset.</description>
- <documentation>
- libs/dynamic_bitset/dynamic_bitset.html</documentation>
+ <key>disjoint_sets</key>
+ <boost-version>1.9.0</boost-version>
+ <name>Disjoint Sets</name>
+ <authors></authors>
+ <description></description>
+ <documentation>Boost.DisjointSets provides disjoint sets
+ operations with union by rank and path
+ compression.</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
<header-only>true</header-only>
<autolink>false</autolink>
</library>
<library>
- <key>disjoint_sets</key>
- <boost-version>1.9.0</boost-version>
- <name>Disjoint Sets</name>
- <authors></authors>
- <description></description>
+ <key>dynamic_bitset</key>
+ <boost-version>1.29.0</boost-version>
+ <name>Dynamic Bitset</name>
+ <authors>Jeremy Siek and Chuck Allison</authors>
+ <description>The dynamic_bitset class represents a set of bits.
+ It provides accesses to the value of individual bits via an
+ operator[] and provides all of the bitwise operators that one
+ can apply to builtin integers, such as operator& and
+ operator<<. The number of bits in the set is specified at
+ runtime via a parameter to the constructor of the
+ dynamic_bitset.</description>
<documentation>
- libs/disjoint_sets/disjoint_sets.html</documentation>
+ libs/dynamic_bitset/dynamic_bitset.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
<header-only>true</header-only>
@@ -210,8 +224,9 @@
<boost-version>1.30.0</boost-version>
<name>Filesystem</name>
<authors>Beman Dawes</authors>
- <description>Portable paths, iteration over directories, and
- other useful filesystem operations.</description>
+ <description>The Boost Filesystem Librar provides portable
+ facilities to query and manipulate paths, files, and
+ directories.</description>
<documentation>libs/filesystem/doc/index.htm</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -223,8 +238,17 @@
<boost-version>1.34.0</boost-version>
<name>Foreach</name>
<authors>Eric Niebler</authors>
- <description>BOOST_FOREACH macro for easily iterating over the
- elements of a sequence.</description>
+ <description>In C++, writing a loop that iterates over a
+ sequence is tedious. We can either use iterators, which
+ requires a considerable amount of boiler-plate, or we can use
+ the std::for_each() algorithm and move our loop body into a
+ predicate, which requires no less boiler-plate and forces us to
+ move our logic far from where it will be used. In contrast,
+ some other languages, like Perl, provide a dedicated "foreach"
+ construct that automates this process. BOOST_FOREACH is just
+ such a construct for C++. It iterates over sequences for us,
+ freeing us from having to deal directly with iterators or write
+ predicates.</description>
<documentation>doc/html/foreach.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -236,8 +260,15 @@
<boost-version>1.29.0</boost-version>
<name>Format</name>
<authors>Samuel Krempp</authors>
- <description>Type-safe 'printf-like' format
- operations.</description>
+ <description>The format library provides a class for formatting
+ arguments according to a format-string, as does printf, but
+ with two major differences: format sends the arguments to an
+ internal stream, and so is entirely type-safe and naturally
+ supports all user-defined types; the ellipsis (...) can not be
+ used correctly in the strongly typed context of format, and
+ thus the function call with arbitrary arguments is replaced by
+ successive calls to an argument feeding
+ operator%.</description>
<documentation>libs/format/index.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -262,7 +293,9 @@
<boost-version>1.16.0</boost-version>
<name>Functional</name>
<authors>Mark Rodgers</authors>
- <description>Enhanced function object adaptors.</description>
+ <description>The Boost.Function library contains a family of
+ class templates that are function object
+ wrappers.</description>
<documentation>libs/functional/index.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -288,8 +321,9 @@
<name>Graph</name>
<authors>Jeremy Siek and a University of Notre Dame
team</authors>
- <description>Generic graph components and
- algorithms.</description>
+ <description>The BGL graph interface and graph components are
+ generic, in the same sense as the the Standard Template Library
+ (STL).</description>
<documentation>
libs/graph/doc/table_of_contents.html</documentation>
<std-proposal>false</std-proposal>
@@ -302,8 +336,13 @@
<boost-version>1.9.0</boost-version>
<name>Integer</name>
<authors></authors>
- <description>Headers to ease dealing with integral
- types.</description>
+ <description>The organization of boost integer headers and
+ classes is designed to take advantage of <stdint.h> types
+ from the 1999 C standard without resorting to undefined
+ behavior in terms of the 1998 C++ standard. The header
+ <boost/cstdint.hpp> makes the standard integer types
+ safely available in namespace boost without placing any names
+ in namespace std.</description>
<documentation>libs/integer/index.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -315,8 +354,10 @@
<boost-version>1.28.0</boost-version>
<name>IO State Savers</name>
<authors>Daryle Walker</authors>
- <description>Save I/O state to prevent jumbled
- data.</description>
+ <description>The I/O sub-library of Boost helps segregate the
+ large number of Boost headers. This sub-library should contain
+ various items to use with/for the standard I/O
+ library.</description>
<documentation>libs/io/doc/ios_state.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -328,8 +369,8 @@
<boost-version>1.33.0</boost-version>
<name>Iostreams</name>
<authors>Jonathan Turkanis</authors>
- <description>Framework for defining streams, stream buffers and
- i/o filters.</description>
+ <description>Boost.IOStreams provides a framework for defining
+ streams, stream buffers and i/o filters.</description>
<documentation>libs/iostreams/doc/index.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -341,8 +382,11 @@
<boost-version>1.21.0</boost-version>
<name>Iterators</name>
<authors>Dave Abrahams, Jeremy Siek, and Thomas Witt</authors>
- <description>Iterator construction framework, adaptors,
- concepts, and more.</description>
+ <description>The Boost Iterator Library contains two parts. The
+ first is a system of concepts which extend the C++ standard
+ iterator requirements. The second is a framework of components
+ for building iterators based on these extended concepts and
+ includes several useful iterator adaptors.</description>
<documentation>libs/iterator/doc/index.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -379,8 +423,18 @@
<boost-version>1.23.0</boost-version>
<name>Math</name>
<authors>various</authors>
- <description>Several contributions in the domain of
- mathematics.</description>
+ <description>Boost.Math includes several contributions in the
+ domain of mathematics: The Greatest Common Divisor and Least
+ Common Multiple library provides run-time and compile-time
+ evaluation of the greatest common divisor (GCD) or least common
+ multiple (LCM) of two integers. The Special Functions library
+ currently provides eight templated special functions, in
+ namespace boost. The Complex Number Inverse Trigonometric
+ Functions are the inverses of trigonometric functions currently
+ present in the C++ standard. Quaternions are a relative of
+ complex numbers often used to parameterise rotations in three
+ dimentional space. Octonions, like quaternions, are a relative
+ of complex numbers.</description>
<documentation>libs/math/doc/index.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -443,8 +497,13 @@
<boost-version>1.30.0</boost-version>
<name>MPL</name>
<authors>Aleksey Gurtovoy</authors>
- <description>Template metaprogramming framework of compile-time
- algorithms, sequences and metafunction classes.</description>
+ <description>The Boost.MPL library is a general-purpose,
+ high-level C++ template metaprogramming framework of
+ compile-time algorithms, sequences and metafunctions. It
+ provides a conceptual foundation and an extensive set of
+ powerful and coherent tools that make doing explict
+ metaprogramming in C++ as easy and enjoyable as possible within
+ the current language.</description>
<documentation>libs/mpl/doc/index.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -456,8 +515,9 @@
<boost-version>1.29.0</boost-version>
<name>Multi-Array</name>
<authors>Ron Garcia</authors>
- <description>Multidimensional containers and adaptors for
- arrays of contiguous data.</description>
+ <description>Boost.MultiArray provides a generic N-dimensional
+ array concept definition and common implementations of that
+ interface.</description>
<documentation>libs/multi_array/doc/index.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -469,8 +529,10 @@
<boost-version>1.32.0</boost-version>
<name>Multi-Index</name>
<authors>Joaquín M López Muñoz</authors>
- <description>Containers with multiple STL-compatible access
- interfaces.</description>
+ <description>The Boost Multi-index Containers Library provides
+ a class template named multi_index_container which enables the
+ construction of containers maintaining one or more indices with
+ different sorting and access semantics.</description>
<documentation>libs/multi_index/doc/index.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -511,8 +573,9 @@
<boost-version>1.29.0</boost-version>
<name>uBLAS</name>
<authors>Joerg Walter and Mathias Koch</authors>
- <description>Basic linear algebra for dense, packed and sparse
- matrices.</description>
+ <description>uBLAS provides matrix and vector classes as well
+ as basic linear algebra routines. Several dense, packed and
+ sparse storage schemes are supported.</description>
<documentation>libs/numeric/ublas/doc/index.htm</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -537,8 +600,8 @@
<boost-version>1.33.0</boost-version>
<name>Parameter</name>
<authors>David Abrahams and Daniel Wallin</authors>
- <description>Write functions that accept arguments by
- name.</description>
+ <description>Boost.Parameter Library - Write functions that
+ accept arguments by name.</description>
<documentation>
libs/parameter/doc/html/index.html</documentation>
<std-proposal>false</std-proposal>
@@ -576,8 +639,10 @@
<boost-version>1.32.0</boost-version>
<name>Program Options</name>
<authors>Vladimir Prus</authors>
- <description>Access to configuration data given on command
- line, in config files and other sources.</description>
+ <description>The program_options library allows program
+ developers to obtain program options, that is (name, value)
+ pairs from the user, via conventional methods such as command
+ line and config file.</description>
<documentation>doc/html/program_options.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -617,8 +682,11 @@
<boost-version>1.19.0</boost-version>
<name>Python</name>
<authors>Dave Abrahams</authors>
- <description>Reflects C++ classes and functions into
- Python.</description>
+ <description>The Boost Python Library is a framework for
+ interfacing Python and C++. It allows you to quickly and
+ seamlessly expose C++ classes functions and objects to Python,
+ and vice-versa, using no special tools -- just your C++
+ compiler.</description>
<documentation>libs/python/doc/index.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -744,10 +812,12 @@
<library>
<key>statechart</key>
<boost-version>1.34.0</boost-version>
- <name></name>
- <authors></authors>
- <description></description>
- <documentation></documentation>
+ <name>Statechart</name>
+ <authors>Andreas Huber Dönni</authors>
+ <description>Boost.Statechart - Arbitrarily complex finite
+ state machines can be implemented in easily readable and
+ maintainable C++ code.</description>
+ <documentation>/libs/statechart/doc/index.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
<header-only>true</header-only>
@@ -809,9 +879,13 @@
<boost-version>1.34.0</boost-version>
<name>TR1</name>
<authors>John Maddock</authors>
- <description>An implementation of the Technical Report on C++
- Library Extensions, using other Boost libraries as a
- basis.</description>
+ <description>The TR1 library provides an implementation of the
+ C++ Technical Report on Standard Library Extensions. This
+ library does not itself implement the TR1 components, rather
+ it's a thin wrapper that will include your standard library's
+ TR1 implementation (if it has one), otherwise it will include
+ the Boost Library equivalents, and import them into namespace
+ std::tr1.</description>
<documentation>doc/html/boost_tr1.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
@@ -848,10 +922,10 @@
<library>
<key>typeof</key>
<boost-version>1.34.0</boost-version>
- <name></name>
- <authors></authors>
- <description></description>
- <documentation></documentation>
+ <name>Typeof</name>
+ <authors>Arkadiy Vertleyb, Peder Holt</authors>
+ <description>Typeof operator emulation.</description>
+ <documentation>/doc/html/typeof.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
<header-only>true</header-only>
@@ -968,9 +1042,10 @@
<boost-version>1.33.0</boost-version>
<name>Wave</name>
<authors>Hartmut Kaiser</authors>
- <description>Standards conformant implementation of the
- mandated C99/C++ preprocessor functionality packed behind an
- easy to use iterator interface.</description>
+ <description>The Boost.Wave library is a Standards conformant,
+ and highly configurable implementation of the mandated C99/C++
+ preprocessor functionality packed behind an easy to use
+ iterator interface.</description>
<documentation>libs/wave/index.html</documentation>
<std-proposal>false</std-proposal>
<std-tr1>false</std-tr1>
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