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

Proposed by Michi Henning
Status: Merged
Approved by: Jussi Pakkanen
Approved revision: no longer in the source branch.
Merged at revision: 604
Proposed branch: lp:~michihenning/unity/doc-comment-fixes
Merge into: lp:unity/phablet
Diff against target: 53 lines (+5/-5)
4 files modified
include/unity/Exception.h (+1/-1)
include/unity/UnityExceptions.h (+1/-1)
include/unity/api/Version.h.in (+1/-1)
src/unity/Exception.cpp (+2/-2)
To merge this branch: bzr merge lp:~michihenning/unity/doc-comment-fixes
Reviewer Review Type Date Requested Status
PS Jenkins bot (community) continuous-integration Approve
Unity Team Pending
Review via email: mp+159282@code.launchpad.net

Commit message

Minor fixes to doxygen comments.

Description of the change

Minor fixes to doxygen comments.

To post a comment you must log in.
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'include/unity/Exception.h'
2--- include/unity/Exception.h 2013-04-08 03:05:05 +0000
3+++ include/unity/Exception.h 2013-04-17 02:28:26 +0000
4@@ -49,7 +49,7 @@
5 The exception nesting is provided by the derivation from <code>std::nested_exception</code>. If you
6 catch an exception and throw another exception from the catch handler, the caught exception
7 is automatically preserved; you can access nested exceptions by calling the <code>nested_ptr()</code> and
8-<code>rethrow_nested()</code> member functions of <code>nested_exception</code>.
9+<code>rethrow_nested()</code> member functions of <code>std::nested_exception</code>.
10
11 In addition, you can remember one or more exceptions by calling remember(). This is useful in situations
12 where you need perform a number of actions that may fail with an error code, and you do not want to
13
14=== modified file 'include/unity/UnityExceptions.h'
15--- include/unity/UnityExceptions.h 2013-04-08 03:05:05 +0000
16+++ include/unity/UnityExceptions.h 2013-04-17 02:28:26 +0000
17@@ -105,7 +105,7 @@
18 Usually, it is not possible to handle or recover
19 from errors that arise during shutdown. This exception is thrown once all possible shutdown actions
20 have been carried out and provides information about anything that went wrong via the exception
21- chaining mechanism of the Unity::Exception base class.
22+ chaining mechanism of the unity::Exception base class.
23 */
24
25 class UNITY_API ShutdownException : public Exception
26
27=== modified file 'include/unity/api/Version.h.in'
28--- include/unity/api/Version.h.in 2013-04-10 09:26:52 +0000
29+++ include/unity/api/Version.h.in 2013-04-17 02:28:26 +0000
30@@ -49,7 +49,7 @@
31 so client code does not need to be recompiled to use the newer library version.
32
33 A different minor version is compatible at the API level, that is, it may add new APIs, but does not change existing
34-ones. API clients must be recompiled for a new major version.
35+ones. API clients must be recompiled for a new minor version.
36
37 A different major version indicates incompatible API changes.
38 */
39
40=== modified file 'src/unity/Exception.cpp'
41--- src/unity/Exception.cpp 2013-04-04 02:16:16 +0000
42+++ src/unity/Exception.cpp 2013-04-17 02:28:26 +0000
43@@ -83,9 +83,9 @@
44 Nested exceptions are indented according to their nesting level. If the exception contains chained
45 exceptions, these are shown in oldest-to-newest order.
46
47-\param indent_level This controls the outermost indent level. The value <code>0</code> indicates
48+\param indent_level This controls the indent level. The value <code>0</code> indicates
49 the outermost level (no indent).
50-\param indent This controls the amount of indenting per level. The pass string is prependended
51+\param indent This controls the amount of indenting per level. The passed string is prependended
52 <i><code>indent_level</code></i> times to each line.
53 \return The string describing the exception.
54

Subscribers

People subscribed via source and target branches