diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
commit | e6918187568dbd01842d8d1d2c808ce16a894239 (patch) | |
tree | 64f88b554b444a49f656b6c656111a145cbbaa28 /src/boost/tools/docca/example/include | |
parent | Initial commit. (diff) | |
download | ceph-upstream/18.2.2.tar.xz ceph-upstream/18.2.2.zip |
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/boost/tools/docca/example/include')
14 files changed, 494 insertions, 0 deletions
diff --git a/src/boost/tools/docca/example/include/docca/issue_101.hpp b/src/boost/tools/docca/example/include/docca/issue_101.hpp new file mode 100644 index 000000000..8b5b53991 --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_101.hpp @@ -0,0 +1,22 @@ +// +// Copyright (c) 2021 Evan Lenz (evan@lenzconsulting.com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_101_HPP +#define EXAMPLE_ISSUE_101_HPP + +namespace example { + +/** Issue 101 + + `typename` parameters should be handled (without generating an error). +*/ +template<typename charT, typename traits> +class issue_101; + +} // example + +#endif diff --git a/src/boost/tools/docca/example/include/docca/issue_33.hpp b/src/boost/tools/docca/example/include/docca/issue_33.hpp new file mode 100644 index 000000000..8323356c9 --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_33.hpp @@ -0,0 +1,27 @@ +// +// Copyright (c) 2020 Krystian Stasiowski (sdkrystian@gmail.com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_33_HPP +#define EXAMPLE_ISSUE_33_HPP + +namespace example { + +/** Issue 33 + + The Note and See Also sections should be distinct. + + @note This is a note + + @see https://boost.org +*/ +struct issue_33 +{ +}; + +} // example + +#endif diff --git a/src/boost/tools/docca/example/include/docca/issue_34.hpp b/src/boost/tools/docca/example/include/docca/issue_34.hpp new file mode 100644 index 000000000..c05f8058d --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_34.hpp @@ -0,0 +1,37 @@ +// +// Copyright (c) 2020 Krystian Stasiowski (sdkrystian@gmail.com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_34_HPP +#define EXAMPLE_ISSUE_34_HPP + +namespace example { + +/** Issue 34 +*/ +class issue_34 +{ + /// Should not be displayed + struct P + { + }; + +public: + /// Base of Q + struct R + { + }; + + /** Q should be derived only from R + */ + struct Q : private P, R + { + }; +}; + +} // example + +#endif diff --git a/src/boost/tools/docca/example/include/docca/issue_38.hpp b/src/boost/tools/docca/example/include/docca/issue_38.hpp new file mode 100644 index 000000000..eb515033d --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_38.hpp @@ -0,0 +1,35 @@ +// +// Copyright (c) 2020 Evan Lenz (evan@lenzconsulting.com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_38_HPP +#define EXAMPLE_ISSUE_38_HPP + +namespace example { + +/** Issue 38 + + Open: [a, b] + Half-open: [a, b) + Closed: (a, b) + + @li Gracefully handle brackets in javadoc comments +*/ +class issue_38 +{ + int i_; + +public: + /** Half-open: [a, b) + + first to last exclusive, i.e. [ first, last ) + */ + issue_38(); +}; + +} // example + +#endif diff --git a/src/boost/tools/docca/example/include/docca/issue_44.hpp b/src/boost/tools/docca/example/include/docca/issue_44.hpp new file mode 100644 index 000000000..790f77f81 --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_44.hpp @@ -0,0 +1,60 @@ +// +// Copyright (c) 2020 Vinnie Falco (vinnie dot falco at gmail dot com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_44_HPP +#define EXAMPLE_ISSUE_44_HPP + +namespace example { + +/** Issue 44 + + @li All of the constructors should be + grouped together on the overload + resolution page. + + @li The class page should show three + unique briefs for the constructor. +*/ +class issue_44 +{ + int i_; + +public: + /** Default constructor. + + Description. + */ + issue_44(); + + /** Constructor. + + Description. + */ + /** @{ */ + issue_44(char); + issue_44(short, short); + /** @} */ + + /** Constructor. + + Description. + */ + /** @{ */ + issue_44(char, int); + issue_44(long, long); + /** @} */ + + /** Void constructor + + Description. + */ + issue_44(void*); +}; + +} // example + +#endif diff --git a/src/boost/tools/docca/example/include/docca/issue_47.hpp b/src/boost/tools/docca/example/include/docca/issue_47.hpp new file mode 100644 index 000000000..03324e131 --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_47.hpp @@ -0,0 +1,34 @@ +// +// Copyright (c) 2020 Vinnie Falco (vinnie dot falco at gmail dot com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_47_HPP +#define EXAMPLE_ISSUE_47_HPP + +namespace example { + +/** Issue 47 + + The function `max_size` should be + listed as a static member. +*/ +class issue_47 +{ + int i_; + +public: + /** Member + */ + void f(); + + /** Static Member + */ + static int max_size() noexcept; +}; + +} // example + +#endif diff --git a/src/boost/tools/docca/example/include/docca/issue_48.hpp b/src/boost/tools/docca/example/include/docca/issue_48.hpp new file mode 100644 index 000000000..9f0b9ea9f --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_48.hpp @@ -0,0 +1,47 @@ +// +// Copyright (c) 2020 Krystian Stasiowski (sdkrystian@gmail.com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_48_HPP +#define EXAMPLE_ISSUE_48_HPP + +namespace example { + +class X +{ +}; + +struct Y +{ +}; + +/** Issue 48 + + The class should show one regular + public member function and two friend + functions. +*/ +class issue_48 +{ + /// This should not be emitted. + friend class X; + + /// This should not be emitted. + friend struct Y; + + /// This should be emitted + friend void g( issue_48 ); + +public: + void f(); + + /// This should be emitted + friend void h( issue_48 ); +}; + +} // example + +#endif diff --git a/src/boost/tools/docca/example/include/docca/issue_52.hpp b/src/boost/tools/docca/example/include/docca/issue_52.hpp new file mode 100644 index 000000000..a39cbd493 --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_52.hpp @@ -0,0 +1,35 @@ +// +// Copyright (c) 2020 Evan Lenz (evan@lenzconsulting.com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_52_HPP +#define EXAMPLE_ISSUE_52_HPP + +namespace example { + +/** Issue 52 + + Constructor and destructor are annotated as such. +*/ +class issue_52 +{ +public: + /** Default constructor. + + Description + */ + issue_52(); + + /** Destructor. + + Description + */ + ~issue_52(); +}; + +} // example + +#endif diff --git a/src/boost/tools/docca/example/include/docca/issue_53.hpp b/src/boost/tools/docca/example/include/docca/issue_53.hpp new file mode 100644 index 000000000..53cfe7521 --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_53.hpp @@ -0,0 +1,44 @@ +// +// Copyright (c) 2020 Evan Lenz (evan@lenzconsulting.com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_53_HPP +#define EXAMPLE_ISSUE_53_HPP + +namespace example { + +/** Issue 53 + + @li Distinct constructor descriptions + should be separated by a silver em dash. +*/ +class issue_53 +{ + int i_; + +public: + /** Default constructor. + + Description. + */ + issue_53(); + + /** Constructor. + + Description. + */ + issue_53(char); + + /** Void constructor + + Description. + */ + issue_53(void*); +}; + +} // example + +#endif diff --git a/src/boost/tools/docca/example/include/docca/issue_55.hpp b/src/boost/tools/docca/example/include/docca/issue_55.hpp new file mode 100644 index 000000000..85628f445 --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_55.hpp @@ -0,0 +1,26 @@ +// +// Copyright (c) 2020 Krystian Stasiowski (sdkrystian@gmail.com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_55_HPP +#define EXAMPLE_ISSUE_55_HPP + +namespace example { + +/** Issue 55 + + Clicking @ref f should lead to the + overload resolution landing page. +*/ +struct issue_55 +{ + void f(int); + void f(double); +}; + +} // example + +#endif diff --git a/src/boost/tools/docca/example/include/docca/issue_63.hpp b/src/boost/tools/docca/example/include/docca/issue_63.hpp new file mode 100644 index 000000000..5b2ab07a3 --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_63.hpp @@ -0,0 +1,41 @@ +// +// Copyright (c) 2021 Evan Lenz (evan@lenzconsulting.com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_63_HPP +#define EXAMPLE_ISSUE_63_HPP + +namespace example { + +/** Issue 63 + + @li Markup (@ commands) in tables should be rendered +*/ +enum class issue_63 +{ + /** + * foo brief + + foo description + + @see issue_55 + */ + foo, + + /** + * bar brief + + bar description + + @li First bullet referencing @ref issue_55 + @li Second bullet + */ + bar +}; + +} // example + +#endif diff --git a/src/boost/tools/docca/example/include/docca/issue_69.hpp b/src/boost/tools/docca/example/include/docca/issue_69.hpp new file mode 100644 index 000000000..28a0d9338 --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_69.hpp @@ -0,0 +1,27 @@ +// +// Copyright (c) 2021 Evan Lenz (evan@lenzconsulting.com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_69_HPP +#define EXAMPLE_ISSUE_69_HPP + +namespace example { + +/** Issue 69 + + The brackets in the @ref operator[] page's + code block should not appear escaped. Nor + should they in that link just there (in this + sentence). +*/ +struct issue_69 +{ + operator[](string_view key); +}; + +} // example + +#endif diff --git a/src/boost/tools/docca/example/include/docca/issue_70.hpp b/src/boost/tools/docca/example/include/docca/issue_70.hpp new file mode 100644 index 000000000..89271d789 --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_70.hpp @@ -0,0 +1,32 @@ +// +// Copyright (c) 2021 Evan Lenz (evan@lenzconsulting.com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_70_HPP +#define EXAMPLE_ISSUE_70_HPP + +namespace example { + +/** Issue 70 + + This reference, @ref issue_70_b::foo, should link to the issue_70_b page + (not issue_63). +*/ +enum class issue_70 +{ + foo, + bar +}; + +enum class issue_70_b +{ + foo, + bar +}; + +} // example + +#endif diff --git a/src/boost/tools/docca/example/include/docca/issue_78.hpp b/src/boost/tools/docca/example/include/docca/issue_78.hpp new file mode 100644 index 000000000..f1b090516 --- /dev/null +++ b/src/boost/tools/docca/example/include/docca/issue_78.hpp @@ -0,0 +1,27 @@ +// +// Copyright (c) 2021 Evan Lenz (evan@lenzconsulting.com) +// +// Distributed under 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) +// + +#ifndef EXAMPLE_ISSUE_78_HPP +#define EXAMPLE_ISSUE_78_HPP + +namespace example { + +/** Issue 78 + + foo() should show up under the heading "Static Member Functions" + and bar should show up under the heading "Static Members" +*/ +class issue_78 +{ +public: + static foo(); + static bar; +}; + +} // example + +#endif |