ceph/src/boost/libs/spirit/doc/concepts_template.qbk

   1 [/==============================================================================
   2     Copyright (C) 2001-2011 Hartmut Kaiser
   3     Copyright (C) 2001-2011 Joel de Guzman
   4
   5     Distributed under the Boost Software License, Version 1.0. (See accompanying
   6     file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   7 ===============================================================================/]
   8
   9 [/------------------------------------------------------------------------------]
  10 [section XXX]
  11
  12 [heading Description]
  13
  14 Description of XXX concept
  15
  16 [heading Refinement of]
  17
  18 [:Link to base concept]
  19
  20 [variablelist Notation
  21     [[`xxx`]     [An XXX]]
  22 ]
  23
  24 [heading Valid Expressions]
  25
  26 (For any XXX the following expressions must be valid:)
  27
  28 In addition to the requirements defined in _XXX-Basic_concept_, for any
  29 XXX the following must be met:
  30
  31 [table
  32     [[Expression]       [Semantics]             [Return type]]
  33     [[`xxx`]            [Semantics of `xxx`]    [XXX]]
  34 ]
  35
  36 [heading Type Expressions]
  37
  38 [table
  39     [[Expression]       [Description]]
  40     [[`XXX`]            [Description of `XXX`]]
  41 ]
  42
  43 [heading Invariants]
  44
  45 For any XXX xxx the following invariants always hold:
  46
  47 [heading Precondition]
  48
  49 Prior to calling FOO the following preconditions should hold:
  50
  51 [heading Precondition]
  52
  53 Upon return from FOO the following postconditions should hold:
  54
  55 [heading Models]
  56
  57 Links to models of XXX concept
  58
  59 [endsect] [/ XXX Concept]