Merge lp:~michihenning/unity-api/doc-comment-fixes into lp:unity-api

[Michi Henning]

A few minor fixes to the doc comments for comparison operators.

A few minor fixes to the doc comments for comparison operators.

[lp:~michihenning/unity-api/doc-comment-fixes]

141. By Michi Henning on 2014-06-25

Oops, a few more corresponding comment fixes.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:140
http://jenkins.qa.ubuntu.com/job/unity-api-ci/214/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-amd64-ci/49
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/49
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/49/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-i386-ci/49

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-api-ci/214/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:141
http://jenkins.qa.ubuntu.com/job/unity-api-ci/215/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-amd64-ci/50
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/50
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-armhf-ci/50/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-utopic-i386-ci/50

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-api-ci/215/rebuild

review: Approve (continuous-integration)

[Michi Henning (michihenning)]

Anyone feel like reviewing this?

[Michi Henning (michihenning)]

Please? Pretty, please?

Cheap karma points up for grabs here!

[Marcus Tomlinson (marcustomlinson)]

LGTM

review: Approve

=== modified file 'include/unity/util/ResourcePtr.h'
--- include/unity/util/ResourcePtr.h	2013-12-13 12:04:56 +0000
+++ include/unity/util/ResourcePtr.h	2014-06-25 23:47:02 +0000
@@ -473,12 +473,12 @@
 }
 
 /**
-\brief Compares two instances for equality by calling the corresponding operator on the resource.
+\brief Compares two instances for equality.
 
 Two instances that do not hold a resource are equal. An instance that does not hold a resource is not equal
 to any instance that holds a resource.
 
-If the underlying operator throws an exception, that exception is propagated to the caller.
+If the underlying <code>operator==</code> throws an exception, that exception is propagated to the caller.
 
 \note This operator is available only if the underlying resource provides <code>operator==</code>.
 */
@@ -510,11 +510,11 @@
 }
 
 /**
-\brief Compares two instances for inequality by calling the corresponding operator on the resource.
-
-If the underlying operator throws an exception, that exception is propagated to the caller.
-
-\note This operator is available only if the underlying resource provides <code>operator!=</code>.
+\brief Compares two instances for inequality.
+
+If the underlying <code>operator==</code> throws an exception, that exception is propagated to the caller.
+
+\note This operator is available only if the underlying resource provides <code>operator==</code>.
 */
 
 template<typename R, typename D>
@@ -525,12 +525,11 @@
 }
 
 /**
-\brief Returns <code>true</code> if <code>this</code> is less than <code>rhs</code> by calling the
-corresponding operator on the resource.
+\brief Returns <code>true</code> if <code>this</code> is less than <code>rhs</code>.
 
 An instance that does not hold a resource is less than any instance that holds a resource.
 
-If the underlying operator throws an exception, that exception is propagated to the caller.
+If the underlying <code>operator\<</code> throws an exception, that exception is propagated to the caller.
 
 \note This operator is available only if the underlying resource provides <code>operator\<</code>.
 */
@@ -562,15 +561,16 @@
 }
 
 /**
-\brief Returns <code>true</code> if <code>this</code> is less than or equal to <code>rhs</code> by calling the
-corresponding operator on the resource.
+\brief Returns <code>true</code> if <code>this</code> is less than or equal to <code>rhs</code>.
 
 An instance that does not hold a resource is less than any instance that holds a resource.
 Two instances that do not hold a resource are equal.
 
-If the underlying operator throws an exception, that exception is propagated to the caller.
+If the underlying <code>operator\<</code> or <code>operator==</code> throws an exception,
+that exception is propagated to the caller.
 
-\note This operator is available only if the underlying resource provides <code>operator\<=</code>.
+\note This operator is available only if the underlying resource provides <code>operator\<</code>
+and <code>operator==</code>.
 */
 
 template<typename R, typename D>
@@ -596,14 +596,15 @@
 }
 
 /**
-\brief Returns <code>true</code> if <code>this</code> is greater than <code>rhs</code> by calling the
-corresponding operator on the resource.
+\brief Returns <code>true</code> if <code>this</code> is greater than <code>rhs</code>.
 
 An instance that holds a resource is greater than any instance that does not hold a resource.
 
-If the underlying operator throws an exception, that exception is propagated to the caller.
+If the underlying <code>operator\<</code> or <code>operator==</code> throws an exception,
+that exception is propagated to the caller.
 
-\note This operator is available only if the underlying resource provides <code>operator\></code>.
+\note This operator is available only if the underlying resource provides <code>operator\<</code>
+and <code>operator==</code>.
 */
 
 template<typename R, typename D>
@@ -614,15 +615,14 @@
 }
 
 /**
-\brief Returns <code>true</code> if <code>this</code> is greater than or equal to <code>rhs</code> by calling the
-corresponding operator on the resource.
+\brief Returns <code>true</code> if <code>this</code> is greater than or equal to <code>rhs</code>.
 
 An instance that holds a resource is greater than any instance that does not hold a resource.
 Two instances that do not hold a resource are equal.
 
-If the underlying operator throws an exception, that exception is propagated to the caller.
+If the underlying <code>operator\<</code> throws an exception, that exception is propagated to the caller.
 
-\note This operator is available only if the underlying resource provides <code>operator\>=</code>.
+\note This operator is available only if the underlying resource provides <code>operator\<</code>.
 */
 
 template<typename R, typename D>