1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
|
<?xml version="1.0" encoding="utf-8"?>
<header name="boost/proto/debug.hpp">
<para>Utilities for debugging Proto expression trees </para>
<namespace name="boost">
<namespace name="proto">
<namespace name="functional">
<!-- proto::functional::display_expr -->
<struct name="display_expr">
<purpose>Pretty-print a Proto expression tree. </purpose>
<description>
<para>
A <conceptname>PolymorphicFunctionObject</conceptname> which accepts a Proto expression tree and pretty-prints it to an <computeroutput>ostream</computeroutput> for debugging purposes.
</para>
</description>
<typedef name="result_type">
<type>void</type>
</typedef>
<method-group name="public member functions">
<method name="operator()" cv="const">
<type>void</type>
<template>
<template-type-parameter name="Expr"/>
</template>
<parameter name="expr">
<paramtype>Expr const &</paramtype>
</parameter>
</method>
</method-group>
<constructor>
<parameter name="sout"><paramtype>std::ostream &</paramtype><default>std::cout</default>
<description>
<para>
The <computeroutput>ostream</computeroutput> to which the expression tree will be written.
</para>
</description>
</parameter>
<parameter name="depth">
<paramtype>int</paramtype>
<default>0</default>
<description>
<para>
The starting indentation depth for this node. Children nodes will be displayed at a starting depth of <computeroutput>depth+4</computeroutput>.
</para>
</description>
</parameter>
</constructor>
</struct>
</namespace>
<!-- proto::display_expr -->
<overloaded-function name="display_expr">
<signature>
<type>void</type>
<template>
<template-type-parameter name="Expr"/>
</template>
<parameter name="expr">
<paramtype>Expr const &</paramtype>
<description>
<para>The Proto expression tree to pretty-print </para>
</description>
</parameter>
<parameter name="sout">
<paramtype>std::ostream &</paramtype>
<description>
<para>
The <computeroutput>ostream</computeroutput> to which the output should be written. If not specified, defaults to <computeroutput>std::cout</computeroutput>.
</para>
</description>
</parameter>
</signature>
<signature>
<type>void</type>
<template>
<template-type-parameter name="Expr"/>
</template>
<parameter name="expr">
<paramtype>Expr const &</paramtype>
</parameter>
</signature>
<purpose>Pretty-print a Proto expression tree. </purpose>
<notes>
<para>
Equivalent to <computeroutput><classname alt="boost::proto::functional::display_expr">proto::functional::display_expr</classname>(0, sout)(expr)</computeroutput>.
</para>
</notes>
</overloaded-function>
</namespace>
</namespace>
</header>
|