Merge lp:~stolowski/unity-scopes-api/mock-docs into lp:unity-scopes-api/devel

[Paweł Stołowski]

Provide brief docstrings for mock classes so that they show up in doxygen documentation.

Provide brief docstrings for mock classes so that they show up in doxygen documentation.
Note, this just makes these 3 classes show up, but no methods are listed since they are in cond/endcond blocks.

[Pete Woods (pete-woods)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'include/unity/scopes/testing/MockPreviewReply.h'
--- include/unity/scopes/testing/MockPreviewReply.h	2015-02-06 00:25:05 +0000
+++ include/unity/scopes/testing/MockPreviewReply.h	2015-04-10 10:11:53 +0000
@@ -33,11 +33,13 @@
 namespace testing
 {
 
-/// @cond
-
+/**
+ \brief Mock for unity::scopes::PreviewReply class.
+ */
 class MockPreviewReply : public unity::scopes::PreviewReply, public unity::scopes::testing::MockObject
 {
 public:
+    /// @cond
     MockPreviewReply() = default;
 
     // From Reply
@@ -49,9 +51,9 @@
     MOCK_METHOD1(register_layout, bool(ColumnLayoutList const&));
     MOCK_METHOD1(push, bool(PreviewWidgetList const&));
     MOCK_METHOD2(push, bool(std::string const&, Variant const&));
+/// @endcond
 };
 
-/// @endcond
 
 } // namespace testing
 

=== modified file 'include/unity/scopes/testing/MockSearchReply.h'
--- include/unity/scopes/testing/MockSearchReply.h	2015-02-12 23:21:47 +0000
+++ include/unity/scopes/testing/MockSearchReply.h	2015-04-10 10:11:53 +0000
@@ -35,11 +35,13 @@
 namespace testing
 {
 
-/// @cond
-
+/**
+ \brief Mock for unity::scopes::SearchReply class.
+ */
 class MockSearchReply : public unity::scopes::SearchReply, public virtual MockObject
 {
 public:
+/// @cond
     MockSearchReply() = default;
 
     // From Reply
@@ -66,9 +68,10 @@
     MOCK_METHOD2(push, bool(Filters const&, FilterState const&));
     MOCK_METHOD1(push, bool(experimental::Annotation const& annotation));
     MOCK_METHOD0(push_surfacing_results_from_cache, void());
+
+/// @endcond
 };
 
-/// @endcond
 
 } // namespace testing
 

=== modified file 'include/unity/scopes/testing/TypedScopeFixture.h'
--- include/unity/scopes/testing/TypedScopeFixture.h	2015-02-22 22:27:09 +0000
+++ include/unity/scopes/testing/TypedScopeFixture.h	2015-04-10 10:11:53 +0000
@@ -65,10 +65,19 @@
     friend class TypedScopeFixture;
 };
 
+/// @endcond
+
+/**
+ \brief Fixture for testing scope testing.
+
+ This fixture template provides convienience SetUp() and TearDown() functions, as well as
+ a number of setters that ease the creation of scope tests.
+ */
 template<typename Scope>
 class TypedScopeFixture : public ::testing::Test
 {
 public:
+/// @cond
     TypedScopeFixture()
         : registry_proxy(&registry, [](unity::scopes::Registry*) {})
         , scope(ScopeTraits<Scope>::construct())
@@ -116,9 +125,9 @@
     unity::scopes::testing::MockRegistry registry;
     unity::scopes::RegistryProxy registry_proxy;
     std::shared_ptr<Scope> scope;
+/// @endcond
 };
 
-/// @endcond
 
 } // namespace testing