Ticket #5886: doc.patch

File doc.patch, 2.3 KB (added by Jamboree <tongari95@…>, 11 years ago)

doc patch

  • doc/algorithm.qbk

     
    6868
    6969[heading Synopsis]
    7070    template <typename Seq1, typename Seq2>
    71     void copy(Seq1 const& src, Seq2& dest);
     71    typename __result_of_copy__<Seq1, Seq2>::type copy(Seq1 const& src, Seq2& dest);
    7272
    7373[table Parameters
    7474    [[Parameter][Requirement][Description]]
     
    101101
    102102[endsect]
    103103
     104[section Metafunctions]
     105
     106[section copy]
     107A metafunction returning the result type of applying __copy__, which is always `void`.
     108
     109[heading Description]
     110
     111[heading Synopsis]
     112    template <typename Seq1, typename Seq2>
     113    struct copy
     114    {
     115        typedef void type;
     116    };
     117
     118[table Parameters
     119    [[Parameter] [Requirement] [Description]]
     120    [[`Seq1`] [A model of __forward_sequence__] [Operation's argument]]
     121    [[`Seq2`] [A model of __forward_sequence__] [Operation's argument]]
     122]
     123
     124[heading Expression Semantics]
     125    __result_of_copy__<Seq1, Seq2>::type
     126
     127[*Return type]: `void`.
     128
     129[*Semantics]: Returns the return type of __copy__ for 2 sequences of types `Seq1` and `Seq2`.
     130The return type is always `void`.
     131
     132[heading Complexity]
     133Constant.
     134
     135[heading Header]
     136
     137    #include <boost/fusion/algorithm/auxiliary/copy.hpp>
     138    #include <boost/fusion/include/copy.hpp>
     139
    104140[endsect]
    105141
     142[endsect]
    106143
     144[endsect]
     145
     146
    107147[section Iteration]
    108148
    109149The iteration algorithms provide the fundamental algorithms for traversing
  • doc/fusion.qbk

     
    216216[def __algorithm__              [link fusion.algorithm Algorithm]]
    217217[def __algorithms__             [link fusion.algorithm Algorithms]]
    218218[def __copy__                   [link fusion.algorithm.auxiliary.functions.copy `copy`]]
     219[def __result_of_copy__         [link fusion.algorithm.auxiliary.metafunctions.copy `result_of::copy`]]
    219220[def __fold__                   [link fusion.algorithm.iteration.functions.fold `fold`]]
    220221[def __result_of_fold__         [link fusion.algorithm.iteration.metafunctions.fold `result_of::fold`]]
    221222[def __reverse_fold__           [link fusion.algorithm.iteration.functions.reverse_fold `reverse_fold`]]