# Copyright John Maddock 2005. Use, modification, and distribution are # subject to 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) import project ; import doxygen ; import quickbook ; project boost/libs/utility/doc ; path-constant INCLUDES : ../include ; path-constant boost-images : ../../../doc/src/images ; # Generate XML doxygen reference for base_from_member component in base_from_member_reference.xml doxygen base_from_member_reference : $(INCLUDES)/boost/utility/base_from_member.hpp : tmp ENABLE_PREPROCESSING=YES EXPAND_ONLY_PREDEF=YES EXTRACT_ALL=NO EXTRACT_PRIVATE=NO HIDE_UNDOC_MEMBERS=YES MACRO_EXPANSION=YES "PREDEFINED= \\ BOOST_UTILITY_DOCS \\ BOOST_SYMBOL_VISIBLE= \\ BOOST_FORCEINLINE=inline \\ BOOST_GPU_ENABLED= \\ BOOST_STATIC_ASSERT(x)= \\ BOOST_STATIC_ASSERT_MSG(x,y)= \\ BOOST_STATIC_CONSTANT(x,y)=\"static constexpr x y\" \\ BOOST_RV_REF(x)=\"x&&\" \\ BOOST_NESTED_TEMPLATE=template \\ BOOST_CONSTEXPR=constexpr \\ BOOST_CXX14_CONSTEXPR=constexpr \\ BOOST_OPERATORS_CONSTEXPR=constexpr \\ BOOST_CONSTEXPR_OR_CONST=constexpr \\ BOOST_NOEXCEPT=noexcept \\ BOOST_NOEXCEPT_IF(x)=noexcept(x) \\ BOOST_NOEXCEPT_EXPR(x)=noexcept(x) \\ BOOST_NOEXCEPT_OR_NOTHROW=noexcept \\ BOOST_COPY_ASSIGN_REF(x)=\"x const&\" \\ BOOST_DEFAULTED_FUNCTION(x,y)=\"x = default;\" \\ BOOST_DELETED_FUNCTION(x)=\"x = delete;\" \\ BOOST_EXPLICIT_OPERATOR_BOOL()=\"explicit operator bool() const;\" \\ BOOST_REF_CONST=const" "EXCLUDE_SYMBOLS= \\ detail \\ F \\ result_of_has_result_type_impl \\ conditional \\ boost::operators_impl" "boost.doxygen.reftitle=Reference" "boost.doxygen.refid=base_from_member.reference" ; # Generate XML doxygen reference for boost_binary component in boost_binary_reference.xml doxygen boost_binary_reference : $(INCLUDES)/boost/utility/binary.hpp : tmp ENABLE_PREPROCESSING=YES EXPAND_ONLY_PREDEF=YES EXTRACT_ALL=NO EXTRACT_PRIVATE=NO HIDE_UNDOC_MEMBERS=YES MACRO_EXPANSION=YES "PREDEFINED= \\ BOOST_UTILITY_DOCS \\ BOOST_SYMBOL_VISIBLE= \\ BOOST_FORCEINLINE=inline \\ BOOST_GPU_ENABLED= \\ BOOST_STATIC_ASSERT(x)= \\ BOOST_STATIC_ASSERT_MSG(x,y)= \\ BOOST_STATIC_CONSTANT(x,y)=\"static constexpr x y\" \\ BOOST_RV_REF(x)=\"x&&\" \\ BOOST_NESTED_TEMPLATE=template \\ BOOST_CONSTEXPR=constexpr \\ BOOST_CXX14_CONSTEXPR=constexpr \\ BOOST_OPERATORS_CONSTEXPR=constexpr \\ BOOST_CONSTEXPR_OR_CONST=constexpr \\ BOOST_NOEXCEPT=noexcept \\ BOOST_NOEXCEPT_IF(x)=noexcept(x) \\ BOOST_NOEXCEPT_EXPR(x)=noexcept(x) \\ BOOST_NOEXCEPT_OR_NOTHROW=noexcept \\ BOOST_COPY_ASSIGN_REF(x)=\"x const&\" \\ BOOST_DEFAULTED_FUNCTION(x,y)=\"x = default;\" \\ BOOST_DELETED_FUNCTION(x)=\"x = delete;\" \\ BOOST_EXPLICIT_OPERATOR_BOOL()=\"explicit operator bool() const;\" \\ BOOST_REF_CONST=const" "EXCLUDE_SYMBOLS= \\ detail \\ F \\ result_of_has_result_type_impl \\ conditional \\ boost::operators_impl" "boost.doxygen.reftitle=Reference" "boost.doxygen.refid=boost_binary.reference" ; # Generate XML doxygen reference for call_traits component in call_traits_reference.xml doxygen call_traits_reference : $(INCLUDES)/boost/call_traits.hpp $(INCLUDES)/boost/detail/call_traits.hpp : tmp ENABLE_PREPROCESSING=YES EXPAND_ONLY_PREDEF=YES EXTRACT_ALL=NO EXTRACT_PRIVATE=NO HIDE_UNDOC_MEMBERS=YES MACRO_EXPANSION=YES "PREDEFINED= \\ BOOST_UTILITY_DOCS \\ BOOST_SYMBOL_VISIBLE= \\ BOOST_FORCEINLINE=inline \\ BOOST_GPU_ENABLED= \\ BOOST_STATIC_ASSERT(x)= \\ BOOST_STATIC_ASSERT_MSG(x,y)= \\ BOOST_STATIC_CONSTANT(x,y)=\"static constexpr x y\" \\ BOOST_RV_REF(x)=\"x&&\" \\ BOOST_NESTED_TEMPLATE=template \\ BOOST_CONSTEXPR=constexpr \\ BOOST_CXX14_CONSTEXPR=constexpr \\ BOOST_OPERATORS_CONSTEXPR=constexpr \\ BOOST_CONSTEXPR_OR_CONST=constexpr \\ BOOST_NOEXCEPT=noexcept \\ BOOST_NOEXCEPT_IF(x)=noexcept(x) \\ BOOST_NOEXCEPT_EXPR(x)=noexcept(x) \\ BOOST_NOEXCEPT_OR_NOTHROW=noexcept \\ BOOST_COPY_ASSIGN_REF(x)=\"x const&\" \\ BOOST_DEFAULTED_FUNCTION(x,y)=\"x = default;\" \\ BOOST_DELETED_FUNCTION(x)=\"x = delete;\" \\ BOOST_EXPLICIT_OPERATOR_BOOL()=\"explicit operator bool() const;\" \\ BOOST_REF_CONST=const" "EXCLUDE_SYMBOLS= \\ detail \\ F \\ result_of_has_result_type_impl \\ conditional \\ boost::operators_impl" "boost.doxygen.reftitle=Reference" "boost.doxygen.refid=call_traits.reference" ; # Generate XML doxygen reference for compressed_pair component in compressed_pair_reference.xml doxygen compressed_pair_reference : $(INCLUDES)/boost/compressed_pair.hpp $(INCLUDES)/boost/detail/compressed_pair.hpp : tmp ENABLE_PREPROCESSING=YES EXPAND_ONLY_PREDEF=YES EXTRACT_ALL=NO EXTRACT_PRIVATE=NO HIDE_UNDOC_MEMBERS=YES MACRO_EXPANSION=YES "PREDEFINED= \\ BOOST_UTILITY_DOCS \\ BOOST_SYMBOL_VISIBLE= \\ BOOST_FORCEINLINE=inline \\ BOOST_GPU_ENABLED= \\ BOOST_STATIC_ASSERT(x)= \\ BOOST_STATIC_ASSERT_MSG(x,y)= \\ BOOST_STATIC_CONSTANT(x,y)=\"static constexpr x y\" \\ BOOST_RV_REF(x)=\"x&&\" \\ BOOST_NESTED_TEMPLATE=template \\ BOOST_CONSTEXPR=constexpr \\ BOOST_CXX14_CONSTEXPR=constexpr \\ BOOST_OPERATORS_CONSTEXPR=constexpr \\ BOOST_CONSTEXPR_OR_CONST=constexpr \\ BOOST_NOEXCEPT=noexcept \\ BOOST_NOEXCEPT_IF(x)=noexcept(x) \\ BOOST_NOEXCEPT_EXPR(x)=noexcept(x) \\ BOOST_NOEXCEPT_OR_NOTHROW=noexcept \\ BOOST_COPY_ASSIGN_REF(x)=\"x const&\" \\ BOOST_DEFAULTED_FUNCTION(x,y)=\"x = default;\" \\ BOOST_DELETED_FUNCTION(x)=\"x = delete;\" \\ BOOST_EXPLICIT_OPERATOR_BOOL()=\"explicit operator bool() const;\" \\ BOOST_REF_CONST=const" "EXCLUDE_SYMBOLS= \\ detail \\ F \\ result_of_has_result_type_impl \\ conditional \\ boost::operators_impl" "boost.doxygen.reftitle=Reference" "boost.doxygen.refid=compressed_pair.reference" ; # Generate XML doxygen reference for in_place_factory component in in_place_factory_reference.xml doxygen in_place_factory_reference : $(INCLUDES)/boost/utility/in_place_factory.hpp $(INCLUDES)/boost/utility/typed_in_place_factory.hpp : tmp ENABLE_PREPROCESSING=YES EXPAND_ONLY_PREDEF=YES EXTRACT_ALL=NO EXTRACT_PRIVATE=NO HIDE_UNDOC_MEMBERS=YES MACRO_EXPANSION=YES "PREDEFINED= \\ BOOST_UTILITY_DOCS \\ BOOST_SYMBOL_VISIBLE= \\ BOOST_FORCEINLINE=inline \\ BOOST_GPU_ENABLED= \\ BOOST_STATIC_ASSERT(x)= \\ BOOST_STATIC_ASSERT_MSG(x,y)= \\ BOOST_STATIC_CONSTANT(x,y)=\"static constexpr x y\" \\ BOOST_RV_REF(x)=\"x&&\" \\ BOOST_NESTED_TEMPLATE=template \\ BOOST_CONSTEXPR=constexpr \\ BOOST_CXX14_CONSTEXPR=constexpr \\ BOOST_OPERATORS_CONSTEXPR=constexpr \\ BOOST_CONSTEXPR_OR_CONST=constexpr \\ BOOST_NOEXCEPT=noexcept \\ BOOST_NOEXCEPT_IF(x)=noexcept(x) \\ BOOST_NOEXCEPT_EXPR(x)=noexcept(x) \\ BOOST_NOEXCEPT_OR_NOTHROW=noexcept \\ BOOST_COPY_ASSIGN_REF(x)=\"x const&\" \\ BOOST_DEFAULTED_FUNCTION(x,y)=\"x = default;\" \\ BOOST_DELETED_FUNCTION(x)=\"x = delete;\" \\ BOOST_EXPLICIT_OPERATOR_BOOL()=\"explicit operator bool() const;\" \\ BOOST_REF_CONST=const" "EXCLUDE_SYMBOLS= \\ detail \\ F \\ result_of_has_result_type_impl \\ conditional \\ boost::operators_impl" "boost.doxygen.reftitle=Reference" "boost.doxygen.refid=in_place_factory.reference" ; # Generate XML doxygen reference for operators component in operators_reference.xml # we skip operators_reference because operators.hpp is not adapted for doxygen # Generate XML doxygen reference for result_of component in result_of_reference.xml doxygen result_of_reference : $(INCLUDES)/boost/utility/result_of.hpp : tmp ENABLE_PREPROCESSING=YES EXPAND_ONLY_PREDEF=YES EXTRACT_ALL=NO EXTRACT_PRIVATE=NO HIDE_UNDOC_MEMBERS=YES MACRO_EXPANSION=YES "PREDEFINED= \\ BOOST_UTILITY_DOCS \\ BOOST_SYMBOL_VISIBLE= \\ BOOST_FORCEINLINE=inline \\ BOOST_GPU_ENABLED= \\ BOOST_STATIC_ASSERT(x)= \\ BOOST_STATIC_ASSERT_MSG(x,y)= \\ BOOST_STATIC_CONSTANT(x,y)=\"static constexpr x y\" \\ BOOST_RV_REF(x)=\"x&&\" \\ BOOST_NESTED_TEMPLATE=template \\ BOOST_CONSTEXPR=constexpr \\ BOOST_CXX14_CONSTEXPR=constexpr \\ BOOST_OPERATORS_CONSTEXPR=constexpr \\ BOOST_CONSTEXPR_OR_CONST=constexpr \\ BOOST_NOEXCEPT=noexcept \\ BOOST_NOEXCEPT_IF(x)=noexcept(x) \\ BOOST_NOEXCEPT_EXPR(x)=noexcept(x) \\ BOOST_NOEXCEPT_OR_NOTHROW=noexcept \\ BOOST_COPY_ASSIGN_REF(x)=\"x const&\" \\ BOOST_DEFAULTED_FUNCTION(x,y)=\"x = default;\" \\ BOOST_DELETED_FUNCTION(x)=\"x = delete;\" \\ BOOST_EXPLICIT_OPERATOR_BOOL()=\"explicit operator bool() const;\" \\ BOOST_REF_CONST=const" "EXCLUDE_SYMBOLS= \\ detail \\ F \\ result_of_has_result_type_impl \\ conditional \\ boost::operators_impl" "boost.doxygen.reftitle=Reference" "boost.doxygen.refid=result_of.reference" ; # Generate XML doxygen reference for string_view component in string_view_reference.xml doxygen string_view_reference : $(INCLUDES)/boost/utility/string_view.hpp $(INCLUDES)/boost/utility/string_ref.hpp : tmp ENABLE_PREPROCESSING=YES EXPAND_ONLY_PREDEF=YES EXTRACT_ALL=NO EXTRACT_PRIVATE=NO HIDE_UNDOC_MEMBERS=YES MACRO_EXPANSION=YES "PREDEFINED= \\ BOOST_UTILITY_DOCS \\ BOOST_SYMBOL_VISIBLE= \\ BOOST_FORCEINLINE=inline \\ BOOST_GPU_ENABLED= \\ BOOST_STATIC_ASSERT(x)= \\ BOOST_STATIC_ASSERT_MSG(x,y)= \\ BOOST_STATIC_CONSTANT(x,y)=\"static constexpr x y\" \\ BOOST_RV_REF(x)=\"x&&\" \\ BOOST_NESTED_TEMPLATE=template \\ BOOST_CONSTEXPR=constexpr \\ BOOST_CXX14_CONSTEXPR=constexpr \\ BOOST_OPERATORS_CONSTEXPR=constexpr \\ BOOST_CONSTEXPR_OR_CONST=constexpr \\ BOOST_NOEXCEPT=noexcept \\ BOOST_NOEXCEPT_IF(x)=noexcept(x) \\ BOOST_NOEXCEPT_EXPR(x)=noexcept(x) \\ BOOST_NOEXCEPT_OR_NOTHROW=noexcept \\ BOOST_COPY_ASSIGN_REF(x)=\"x const&\" \\ BOOST_DEFAULTED_FUNCTION(x,y)=\"x = default;\" \\ BOOST_DELETED_FUNCTION(x)=\"x = delete;\" \\ BOOST_EXPLICIT_OPERATOR_BOOL()=\"explicit operator bool() const;\" \\ BOOST_REF_CONST=const" "EXCLUDE_SYMBOLS= \\ detail \\ F \\ result_of_has_result_type_impl \\ conditional \\ boost::operators_impl" "boost.doxygen.reftitle=Reference" "boost.doxygen.refid=string_view.reference" ; # Generate XML doxygen reference for value_init component in value_init_reference.xml doxygen value_init_reference : $(INCLUDES)/boost/utility/value_init.hpp : tmp ENABLE_PREPROCESSING=YES EXPAND_ONLY_PREDEF=YES EXTRACT_ALL=NO EXTRACT_PRIVATE=NO HIDE_UNDOC_MEMBERS=YES MACRO_EXPANSION=YES "PREDEFINED= \\ BOOST_UTILITY_DOCS \\ BOOST_SYMBOL_VISIBLE= \\ BOOST_FORCEINLINE=inline \\ BOOST_GPU_ENABLED= \\ BOOST_STATIC_ASSERT(x)= \\ BOOST_STATIC_ASSERT_MSG(x,y)= \\ BOOST_STATIC_CONSTANT(x,y)=\"static constexpr x y\" \\ BOOST_RV_REF(x)=\"x&&\" \\ BOOST_NESTED_TEMPLATE=template \\ BOOST_CONSTEXPR=constexpr \\ BOOST_CXX14_CONSTEXPR=constexpr \\ BOOST_OPERATORS_CONSTEXPR=constexpr \\ BOOST_CONSTEXPR_OR_CONST=constexpr \\ BOOST_NOEXCEPT=noexcept \\ BOOST_NOEXCEPT_IF(x)=noexcept(x) \\ BOOST_NOEXCEPT_EXPR(x)=noexcept(x) \\ BOOST_NOEXCEPT_OR_NOTHROW=noexcept \\ BOOST_COPY_ASSIGN_REF(x)=\"x const&\" \\ BOOST_DEFAULTED_FUNCTION(x,y)=\"x = default;\" \\ BOOST_DELETED_FUNCTION(x)=\"x = delete;\" \\ BOOST_EXPLICIT_OPERATOR_BOOL()=\"explicit operator bool() const;\" \\ BOOST_REF_CONST=const" "EXCLUDE_SYMBOLS= \\ detail \\ F \\ result_of_has_result_type_impl \\ conditional \\ boost::operators_impl" "boost.doxygen.reftitle=Reference" "boost.doxygen.refid=value_init.reference" ; # Generate main.xml boostbook documentation from main.qbk quickbook documentation xml main : main.qbk ; # Generate ./html documentation from main.xml boostbook documentation # Each doxygen reference in quickbook files with [xinclude tmp/_reference.xml] becomes: # # in boostbook. # All of these commands give the reference the id "utility.reference" boostbook standalone_main : main : base_from_member_reference boost_binary_reference call_traits_reference compressed_pair_reference in_place_factory_reference result_of_reference string_view_reference value_init_reference # File name of HTML output: # root.filename=main boost.root=../../../.. pdf:"boost.url.prefix=http://www.boost.org/doc/libs/release/libs/utility/doc/html" # How far down we chunk nested sections: no more than two so utility component pages include their reference chunk.section.depth=2 # 8 # Don't put the first section on the same page as the TOC: chunk.first.sections=1 # 1 # How far down sections get TOC: 2 so we show each Utility component in main page but no more than that toc.section.depth=2 # 2 # Max depth in each TOC: 2 so we show each Utility component in main page but no more than that toc.max.depth=2 # 2 # How far down we go with TOC's in main page: 2 so each Utility component page has 1 level TOC generate.section.toc.level=2 # 2 ; ############################################################################### alias boostdoc ; explicit boostdoc ; alias boostrelease : standalone_main ; explicit boostrelease ;