Boost logo

Boost :

From: Angus Leeming (angus.leeming_at_[hidden])
Date: 2004-06-18 11:31:21


Is it possible to get the BoostBook/Doxygen documentation system to
include my commentary? This is the header file

#include <boost/child/detail/pipe_mode.hpp>

namespace boost {
namespace child {

/// A stateless class providing constants and typenames.
struct pipes_base
{
    /// A type used to specify how to communciate with the child process.
    typedef detail::pipe_mode pipe_mode;

    /// Write to the child's standard input stream.
    static const pipe_mode child_stdin = pipe_mode(1);

    /// Read from the child's standard output stream.
    static const pipe_mode child_stdout = pipe_mode(2);

    /// Read from the child's standard error stream.
    static const pipe_mode child_stderr = pipe_mode(4);

    /// Redirect the child's stderr to its stdout.
    static const pipe_mode redirect_child_stderr = pipe_mode(8);

    /// No pipes are to be used.
    static const pipe_mode no_pipes = pipe_mode(16);
};

} // namespace child
} // namespace boost

And below is the generated documentation. See how all the descriptions of
the constants have dissappeared. Also see how the typedef has been
'modified'.

Regards,
Angus

Struct pipes_base

boost::child::pipes_base ? A stateless class providing constants and
typenames.

Synopsis

struct pipes_base {
  // types
  typedef unspecified pipe_mode; // A type used to specify how to
communciate with the child process.

  static const pipe_mode child_stdin;
  static const pipe_mode child_stdout;
  static const pipe_mode child_stderr;
  static const pipe_mode redirect_child_stderr;
  static const pipe_mode no_pipes;
};


Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk