diff options
author | John Maddock <john@johnmaddock.co.uk> | 2008-12-05 16:34:46 +0000 |
---|---|---|
committer | John Maddock <john@johnmaddock.co.uk> | 2008-12-05 16:34:46 +0000 |
commit | 351ce1eaf0e724910bfb981dc78396d2dabafd65 (patch) | |
tree | f57cec20173cfe280b66572ebe42d2061f389be4 /doc/test/stub.cpp | |
parent | 508bc6ccb0027598b2e97ef274a1000f1d81b475 (diff) | |
download | boost-351ce1eaf0e724910bfb981dc78396d2dabafd65.tar.gz |
Added initial documentation test.
[SVN r50136]
Diffstat (limited to 'doc/test/stub.cpp')
-rw-r--r-- | doc/test/stub.cpp | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/test/stub.cpp b/doc/test/stub.cpp new file mode 100644 index 0000000000..48e76d0860 --- /dev/null +++ b/doc/test/stub.cpp @@ -0,0 +1,69 @@ +/*============================================================================= + Copyright (c) 2006 Joel de Guzman + http://spirit.sourceforge.net/ + + Use, modification and distribution is subject to the Boost Software + License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at + http://www.boost.org/LICENSE_1_0.txt) +=============================================================================*/ +#include <string> + +//[ bar +//` This is the [*/bar/] function +std::string bar() +{ + // return 'em, bar man! + return "bar"; +} +//] + +//[ foo +/*` This is the [*['foo]] function. */ +std::string foo() +{ + // return 'em, foo man! + return "foo"; +} +//] + +//[ foo_bar +std::string foo_bar() /*< The /Mythical/ FooBar. + See [@http://en.wikipedia.org/wiki/Foobar Foobar for details] >*/ +{ + return "foo-bar"; /*< return 'em, foo-bar man! >*/ +} +//] + +//[ class_ +class x +{ +public: + + /*<< Constructor >>*/ + x() : n(0) + { + } + + /*<< Destructor >>*/ + ~x() + { + } + + /*<< Get the `n` member variable >>*/ + int get() const + { + return n; /*<- this will be ignored by quickbook ->*/ + } + + /*<< Set the `n` member variable >>*/ + void set(int n_) + { + n = n_; + } +//<- this will be ignored by quickbook +private: + + int n; +//-> +}; +//] |