2
0
mirror of https://github.com/boostorg/gil.git synced 2026-02-02 08:52:10 +00:00

The tests and documentations for toolbox extension.

[SVN r82767]
This commit is contained in:
Christian Henning
2013-02-07 01:30:56 +00:00
committed by Stefan Seefeld
parent 18eacb424b
commit a674663915
2 changed files with 112 additions and 0 deletions

67
toolbox/doc/jamfile.v2 Normal file
View File

@@ -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
]
:
<doxygen:param>"PROJECT_NAME=\"Boost GIL Toolbox\""
<doxygen:param>"PROJECT_LOGO=\"$(BOOST_ROOT)/boost.png\""
#messages
<doxygen:param>QUIET=YES
<doxygen:param>WARN_IF_UNDOCUMENTED=YES
<doxygen:param>WARN_IF_DOC_ERROR=YES
# input
<doxygen:param>JAVADOC_AUTOBRIEF=YES
<doxygen:param>EXTRACT_PRIVATE=NO
<doxygen:param>EXTRACT_STATIC=YES
<doxygen:param>HIDE_UNDOC_MEMBERS=YES
<doxygen:param>HIDE_UNDOC_CLASSES=YES
# output
<doxygen:param>HIDE_SCOPE_NAMES=YES
<doxygen:param>INLINE_INFO=NO
<doxygen:param>SORT_MEMBER_DOCS=NO
<doxygen:param>SHOW_DIRECTORIES=YES
<doxygen:param>SOURCE_BROWSER=YES
<doxygen:param>REFERENCED_BY_RELATION=NO
<doxygen:param>REFERENCES_RELATION=NO
<doxygen:param>REFERENCES_LINK_SOURCE=NO
<doxygen:param>VERBATIM_HEADERS=NO
<doxygen:param>HIDE_UNDOC_RELATIONS=NO
<doxygen:param>"EXCLUDE_SYMBOLS = \"detail::*\""
;
xml toolbox : toolbox.qbk ;
boostbook standalone
:
toolbox
:
<xsl:param>boost.root=../../../../..
<xsl:param>boost.max.id.length=1024
<xsl:param>toc.max.depth=4
<xsl:param>toc.section.depth=4
<xsl:param>chunk.section.depth=2
;

45
toolbox/doc/toolbox.qbk Normal file
View File

@@ -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]