libs/contract/doc/main.qbk

   1
   2 [/ Copyright (C) 2008-2018 Lorenzo Caminiti]
   3 [/ Distributed under the Boost Software License, Version 1.0 (see accompanying]
   4 [/ file LICENSE_1_0.txt or a copy at http://www.boost.org/LICENSE_1_0.txt).]
   5 [/ See: http://www.boost.org/doc/libs/release/libs/contract/doc/html/index.html]
   6
   7 [library Boost.Contract
   8     [quickbook 1.5]
   9     [version 1.0.0]
  10     [purpose Contract programming for C++.]
  11     [authors [Caminiti <email>lorcaminiti@gmail.com</email>, Lorenzo]]
  12     [copyright 2008-2019 Lorenzo Caminiti]
  13     [license Distributed under the Boost Software License, Version 1.0 (see accompanying file LICENSE_1_0.txt or a copy at [@http://www.boost.org/LICENSE_1_0.txt])]
  14     [source-mode c++]
  15 ]
  16
  17 [def __Introduction__ [link boost_contract.introduction Introduction]]
  18 [def __Full_Table_of_Contents__ [link boost_contract.full_table_of_contents Full Table of Contents]]
  19
  20 [def __Getting_Started__ [link boost_contract.getting_started Getting Started]]
  21 [def __This_Documentation__ [link boost_contract.getting_started.this_documentation This Documentation]]
  22 [def __Compilers_and_Platforms__ [link boost_contract.getting_started.compilers_and_platforms Compilers and Platforms]]
  23 [def __Code_Organization__ [link boost_contract.getting_started.code_organization Code Organization]]
  24 [def __Build__ [link boost_contract.getting_started.build Build]]
  25
  26 [def __Contract_Programming_Overview__ [link boost_contract.contract_programming_overview Contract Programming Overview]]
  27 [def __Assertions__ [link boost_contract.contract_programming_overview.assertions Assertions]]
  28 [def __Benefits_and_Costs__ [link boost_contract.contract_programming_overview.benefits_and_costs Benefits and Costs]]
  29 [def __Function_Calls__ [link boost_contract.contract_programming_overview.function_calls Function Calls]]
  30 [def __Public_Function_Calls__ [link boost_contract.contract_programming_overview.public_function_calls Public Function Calls]]
  31 [def __Constructor_Calls__ [link boost_contract.contract_programming_overview.constructor_calls Constructor Calls]]
  32 [def __Destructor_Calls__ [link boost_contract.contract_programming_overview.destructor_calls Destructor Calls]]
  33 [def __Constant_Correctness__ [link boost_contract.contract_programming_overview.constant_correctness Constant-Correctness]]
  34 [def __Specifications_vs_Implementation__ [link boost_contract.contract_programming_overview.specifications_vs__implementation Specifications vs. Implementation]]
  35 [def __On_Contract_Failures__ [link boost_contract.contract_programming_overview.on_contract_failures On Contract Failures]]
  36 [def __Feature_Summary__ [link boost_contract.contract_programming_overview.feature_summary Feature Summary]]
  37
  38 [def __Tutorial__ [link boost_contract.tutorial Tutorial]]
  39 [def __Non_Member_Functions__ [link boost_contract.tutorial.non_member_functions Non-Member Functions]]
  40 [def __Preconditions__ [link boost_contract.tutorial.preconditions Preconditions]]
  41 [def __Postconditions__ [link boost_contract.tutorial.postconditions Postconditions]]
  42 [def __Return_Values__ [link boost_contract.tutorial.return_values Return Values]]
  43 [def __Old_Values__ [link boost_contract.tutorial.old_values Old Values]]
  44 [def __Exception_Guarantees__ [link boost_contract.tutorial.exception_guarantees Exception Guarantees]]
  45 [def __Class_Invariants__ [link boost_contract.tutorial.class_invariants Class Invariants]]
  46 [def __Constructors__ [link boost_contract.tutorial.constructors Constructors]]
  47 [def __Destructors__ [link boost_contract.tutorial.destructors Destructors]]
  48 [def __Public_Functions__ [link boost_contract.tutorial.public_functions Public Functions]]
  49 [def __Virtual_Public_Functions__ [link boost_contract.tutorial.virtual_public_functions Virtual Public Functions]]
  50 [def __Public_Function_Overrides__ [link boost_contract.tutorial.public_function_overrides__subcontracting_ Public Function Overrides]]
  51 [def __Public_Function_Overrides_Subcontracting__ [link boost_contract.tutorial.public_function_overrides__subcontracting_ Public Function Overrides (Subcontracting)]]
  52 [def __Base_Classes__ [link boost_contract.tutorial.base_classes__subcontracting_ Base Classes]]
  53 [def __Base_Classes_Subcontracting__ [link boost_contract.tutorial.base_classes__subcontracting_ Base Classes (Subcontracting)]]
  54 [def __Static_Public_Functions__ [link boost_contract.tutorial.static_public_functions Static Public Functions]]
  55
  56 [def __Advanced__ [link boost_contract.advanced Advanced]]
  57 [def __Pure_Virtual_Public_Functions__ [link boost_contract.advanced.pure_virtual_public_functions Pure Virtual Public Functions]]
  58 [def __Optional_Return_Values__ [link boost_contract.advanced.optional_return_values Optional Return Values]]
  59 [def __Private_and_Protected_Functions__ [link boost_contract.advanced.private_and_protected_functions Private and Protected Functions]]
  60 [def __Friend_Functions__ [link boost_contract.advanced.friend_functions Friend Functions]]
  61 [def __Function_Overloads__ [link boost_contract.advanced.function_overloads Function Overloads]]
  62 [def __Lambdas_Loops_Code_Blocks__ [link boost_contract.advanced.lambdas__loops__code_blocks__and__constexpr__ Lambdas, Loops, Code Blocks]]
  63 [def __Lambdas_Loops_Code_Blocks_and_constexpr__ [link boost_contract.advanced.lambdas__loops__code_blocks__and__constexpr__ Lambdas, Loops, Code Blocks (and `constexpr`)]]
  64 [def __Implementation_Checks__ [link boost_contract.advanced.implementation_checks Implementation Checks]]
  65 [def __Old_Values_Copied_at_Body__ [link boost_contract.advanced.old_values_copied_at_body Old Values Copied at Body]]
  66 [def __Named_Overrides__ [link boost_contract.advanced.named_overrides Named Overrides]]
  67 [def __Access_Specifiers__ [link boost_contract.advanced.access_specifiers Access Specifiers]]
  68 [def __Throw_on_Failures__ [link boost_contract.advanced.throw_on_failures__and__noexcept__ Throw on Failures]]
  69 [def __Throw_on_Failures_and_noexcept__ [link boost_contract.advanced.throw_on_failures__and__noexcept__ Throw on Failures (and `noexcept`)]]
  70
  71 [def __Extras__ [link boost_contract.extras Extras]]
  72 [def __Old_Value_Requirements__ [link boost_contract.extras.old_value_requirements__templates_ Old Value Requirements]]
  73 [def __Old_Value_Requirements_Templates__ [link boost_contract.extras.old_value_requirements__templates_ Old Value Requirements (Templates)]]
  74 [def __Assertion_Requirements__ [link boost_contract.extras.assertion_requirements__templates_ Assertion Requirements]]
  75 [def __Assertion_Requirements_Templates__ [link boost_contract.extras.assertion_requirements__templates_ Assertion Requirements (Templates)]]
  76 [def __Volatile_Public_Functions__ [link boost_contract.extras.volatile_public_functions Volatile Public Functions]]
  77 [def __Move_Operations__ [link boost_contract.extras.move_operations Move Operations]]
  78 [def __Unions__ [link boost_contract.extras.unions Unions]]
  79 [def __Disable_Contract_Checking__ [link boost_contract.extras.disable_contract_checking Disable Contract Checking]]
  80 [def __Assertion_Levels__ [link boost_contract.extras.assertion_levels Assertion Levels]]
  81 [def __Disable_Contract_Compilation__ [link boost_contract.extras.disable_contract_compilation__macro_interface_ Disable Contract Compilation]]
  82 [def __Disable_Contract_Compilation_Macro_Interface__ [link boost_contract.extras.disable_contract_compilation__macro_interface_ Disable Contract Compilation (Macro Interface)]]
  83 [def __Separate_Body_Implementation__ [link boost_contract.extras.separate_body_implementation Separate Body Implementation]]
  84 [def __No_Lambda_Functions__ [link boost_contract.extras.no_lambda_functions__no_c__11_ No Lambda Functions]]
  85 [def __No_Lambda_Functions_No_CXX11__ [link boost_contract.extras.no_lambda_functions__no_c__11_ No Lambda Functions (No C++11)]]
  86 [def __No_Macros__ [link boost_contract.extras.no_macros__and_no_variadic_macros_ No Macros]]
  87 [def __No_Macros_and_No_Variadic_Macros__ [link boost_contract.extras.no_macros__and_no_variadic_macros_ No Macros (and No Variadic Macros)]]
  88
  89 [def __Reference__ [@reference.html Reference]]
  90 [def __Examples__ [link boost_contract.examples Examples]]
  91 [def __Release_Notes__ [link boost_contract.release_notes Release Notes]]
  92 [def __Bibliography__ [link boost_contract.bibliography Bibliography]]
  93 [def __Acknowledgments__ [link boost_contract.acknowledgments Acknowledgments]]
  94
  95 [def __AND__ [link and_anchor [^['AND]]]]
  96 [def __OR__ [link or_anchor [^['OR]]]]
  97
  98 [def __Bright04__ [link Bright04_anchor \[Bright04\]]]
  99 [def __Bright04b__ [link Bright04b_anchor \[Bright04b\]]]
 100 [def __C2__ [link C2_anchor \[C2\]]]
 101 [def __Chrome__ [link Chrome_anchor \[Chrome\]]]
 102 [def __Cline90__ [link Cline90_anchor \[Cline90\]]]
 103 [def __CodeContracts__ [link CodeContracts_anchor \[CodeContracts\]]]
 104 [def __iContract__ [link iContract_anchor \[iContract\]]]
 105 [def __Nana__ [link Nana_anchor \[Nana\]]]
 106 [def __Hoare73__ [link Hoare73_anchor \[Hoare73\]]]
 107 [def __Jcontract__ [link Jcontract_anchor \[Jcontract\]]]
 108 [def __Lindrud04__ [link Lindrud04_anchor \[Lindrud04\]]]
 109 [def __Maley99__ [link Maley99_anchor \[Maley99\]]]
 110 [def __Meyer97__ [link Meyer97_anchor \[Meyer97\]]]
 111 [def __Mitchell02__ [link Mitchell02_anchor \[Mitchell02\]]]
 112 [def __N1613__ [link N1613_anchor \[N1613\]]]
 113 [def __N1866__ [link N1866_anchor \[N1866\]]]
 114 [def __N1962__ [link N1962_anchor \[N1962\]]]
 115 [def __N2081__ [link N2081_anchor \[N2081\]]]
 116 [def __N2914__ [link N2914_anchor \[N2914\]]]
 117 [def __N3613__ [link N3613_anchor \[N3613\]]]
 118 [def __P0380__ [link P0380_anchor \[P0380\]]]
 119 [def __SPARKAda__ [link SPARKAda_anchor \[SPARKAda\]]]
 120 [def __SpecSharp__ [link SpecSharp_anchor \[SpecSharp\]]]
 121 [def __Stroustrup94__ [link Stroustrup94_anchor \[Stroustrup94\]]]
 122 [def __Stroustrup13__ [link Stroustrup13_anchor \[Stroustrup13\]]]
 123 [def __Tandin04__ [link Tandin04_anchor \[Tandin04\]]]
 124
 125 [def __substitution_principle__ [@http://en.wikipedia.org/wiki/Liskov_substitution_principle substitution principle]]
 126
 127 [:['["Our field needs more formality, but the profession has not realized it yet.]]]
 128 [:['-- Bertrand Meyer (see __Meyer97__ page 400)]]
 129
 130 This library implements
 131 [@http://en.wikipedia.org/wiki/Design_by_contract contract programming] (a.k.a., Design by Contract or DbC)
 132 [footnote
 133 Design by Contract (DbC) is a registered trademark of the Eiffel Software company and it was first introduced by the Eiffel programming language (see __Meyer97__).
 134 ]
 135 for the C++ programming language.
 136 All contract programming features are supported by this library: Subcontracting, class invariants (also for static and volatile member functions), postconditions (with old and return values), preconditions, customizable actions on assertion failure (e.g., terminate the program or throw exceptions), optional compilation of assertions, disable assertions while already checking other assertions (to avoid infinite recursion), and more (see __Feature_Summary__).
 137
 138 [include introduction.qbk]
 139 [include full_table_of_contents.qbk]
 140 [include getting_started.qbk]
 141 [include contract_programming_overview.qbk]
 142 [include tutorial.qbk]
 143 [include advanced.qbk]
 144 [include extras.qbk]
 145 [include examples.qbk]
 146 [xinclude reference.xml]
 147 [include release_notes.qbk]
 148 [include bibliography.qbk]
 149 [include acknowledgments.qbk]
 150