doc updates to reflect structure changes

[SVN r40827]
This commit is contained in:
Joel de Guzman
2007-11-06 10:09:38 +00:00
parent c9ee80e47a
commit 0baf64588c
11 changed files with 1351 additions and 1330 deletions

View File

@ -9,13 +9,20 @@ The library is organized in three layers:
[:[$images/fusion_org.png]]
The entire library is found in the "boost/fusion" directory. Modules are
organized in directories. Each module has its own header file placed in the
same directory with the actual module-directory. For example, there exists
"boost/fusion/support.hpp" in the same directory as "boost/fusion/support".
Everything, except those found inside "detail" directories, is public. The
library is header-only. There is no need to build object files to link
against.
The entire library is found in the "boost/fusion" directory. Modules are
organized in directories. Each module has its own header file placed in
the same directory with the actual module-directory. For example, there
exists "boost/fusion/support.hpp" in the same directory as
"boost/fusion/support". Everything, except those found inside "detail"
directories, is public.
There is also a "boost/fusion/include/" directory that contains all the
headers to all the components and modules. If you are unsure where to
find a specific component or module, or don't want to fuss with
hierarchy and nesting, use this.
The library is header-only. There is no need to build object files to
link against.
[heading Directory]
@ -24,45 +31,49 @@ against.
* iteration
* query
* transformation
* adapted
* array
* mpl
* boost::tuple
* std_pair
* struct
* variant
* view
* filter_view
* iterator_range
* joint_view
* reverse_view
* single_view
* transform_view
* zip_view
* container
* deque
* list
* map
* set
* vector
* mpl
* functional
* sequence
* adapted
* array
* mpl
* std_pair
* comparison
* container
* list
* map
* set
* vector
* conversion
* generation
* intrinsic
* io
* utility
* view
* filter_view
* iterator_range
* joint_view
* reverse_view
* single_view
* transform_view
* zip_view
* iterator
* support
[heading Example]
If, for example, you want to use `list`, depending on the granularity that
If, for example, you want to use `list`, depending on the granularity that
you desire, you may do so by including one of
#include <boost/fusion/sequence.hpp>
#include <boost/fusion/sequence/container.hpp>
#include <boost/fusion/sequence/container/list.hpp>
The first includes all sequences. The second includes all of sequence
containers. The third includes only `list` [footnote Modules may contain
smaller components. Header file information for each component will be
provided as part of the component's documentation.].
#include <boost/fusion/container.hpp>
#include <boost/fusion/container/list.hpp>
The first includes all containers The second includes only `list`
[footnote Modules may contain smaller components. Header file
information for each component will be provided as part of the
component's documentation.].
[endsect]