diff --git a/toolbox/doc/jamfile.v2 b/toolbox/doc/jamfile.v2 new file mode 100644 index 000000000..a3226b574 --- /dev/null +++ b/toolbox/doc/jamfile.v2 @@ -0,0 +1,67 @@ +# Boost.GIL.ToolBox +# +# Copyright (c) 2012 Christian Henning +# +# 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) + + +# Quickbook +# ----------------------------------------------------------------------------- + +use-project boost : c:/boost ; + +using quickbook ; +using doxygen ; +using boostbook ; + +# taken from http://boost.2283326.n4.nabble.com/Doxygen-Running-Doxygen-from-BB-td3657608.html +doxygen reference.html + : + [ glob + ../../../../boost/gil/extension/toolbox/*.hpp + ../../../../boost/gil/extension/toolbox/color_converters/*.hpp + ../../../../boost/gil/extension/toolbox/color_spaces/*.hpp + ../../../../boost/gil/extension/toolbox/image_types/*.hpp + ../../../../boost/gil/extension/toolbox/metafunctions/*.hpp + ] + : + "PROJECT_NAME=\"Boost GIL Toolbox\"" + "PROJECT_LOGO=\"$(BOOST_ROOT)/boost.png\"" + #messages + QUIET=YES + WARN_IF_UNDOCUMENTED=YES + WARN_IF_DOC_ERROR=YES + # input + JAVADOC_AUTOBRIEF=YES + EXTRACT_PRIVATE=NO + EXTRACT_STATIC=YES + HIDE_UNDOC_MEMBERS=YES + HIDE_UNDOC_CLASSES=YES + # output + HIDE_SCOPE_NAMES=YES + INLINE_INFO=NO + SORT_MEMBER_DOCS=NO + SHOW_DIRECTORIES=YES + SOURCE_BROWSER=YES + REFERENCED_BY_RELATION=NO + REFERENCES_RELATION=NO + REFERENCES_LINK_SOURCE=NO + VERBATIM_HEADERS=NO + HIDE_UNDOC_RELATIONS=NO + "EXCLUDE_SYMBOLS = \"detail::*\"" + ; + +xml toolbox : toolbox.qbk ; + +boostbook standalone + : + toolbox + : + boost.root=../../../../.. + boost.max.id.length=1024 + toc.max.depth=4 + toc.section.depth=4 + chunk.section.depth=2 + ; diff --git a/toolbox/doc/toolbox.qbk b/toolbox/doc/toolbox.qbk new file mode 100644 index 000000000..1280d3475 --- /dev/null +++ b/toolbox/doc/toolbox.qbk @@ -0,0 +1,45 @@ +[library Boost.GIL.ToolBox + [quickbook 1.5] + [id toolbox] + [dirname gil/extension/toolbox] + [purpose An mixed bag of some small extension for boost::gil] + [category Image Processing] + [authors [Henning, Christian]] + [copyright 2012 Christian Henning] + [source-mode c++] + [license + 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]) + ] +] + +[def __Reference__ [@reference.html Reference]] + +[section Overview] + +ToolBox provides some helpful extension for boost::gil that are too small to be an extension themselves. There are: + +* color spaces: cmyka, gray_alpha, hsl, hsv, lab, xyz +* metafunctions: channel_type_to_index, is_bit_aligned, is_similar, is_homogeneous, get_num_bits, channel_type, get_pixel_type, pixel_bit_size +* image types: indexed_image +* color converters: gray -> rgba + +This extension will hopefully be added on by the community. + +This extension is header-only. To use the toolbox just include the boost/gil/extension/toolbox.hpp. + +[heading Folder Srtucture ] + +The toolbox tries to structure the small boost::gil extension into various folders. There is a folder for color_spaces, metafunctions, image_types, and color converters. + +[heading Acknowledgements] + +Thanks to all the people who have reviewed this library and made suggestions for improvements. + +[heading Referece] + +The __Reference__ section. + +[endsect] +