Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
dlib
Commits
992175a6
Commit
992175a6
authored
Aug 19, 2014
by
Davis King
Browse files
Fixed spelling error and clarified docs
parent
6b4d17e5
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
4 additions
and
4 deletions
+4
-4
docs/docs/howto_contribute.xml
docs/docs/howto_contribute.xml
+1
-1
docs/docs/intro.xml
docs/docs/intro.xml
+3
-3
No files found.
docs/docs/howto_contribute.xml
View file @
992175a6
...
@@ -419,7 +419,7 @@ for (int i = 0; i < my_std_vector.size(); ++i)
...
@@ -419,7 +419,7 @@ for (int i = 0; i < my_std_vector.size(); ++i)
be able to easily find out what exception was thrown. Additionally, exceptions typically contain a
be able to easily find out what exception was thrown. Additionally, exceptions typically contain a
message telling you all about the error. Moreover,
message telling you all about the error. Moreover,
any debugger worth its
any debugger worth its
salt will be able to show you a stack trace that let
'
s you see exactly where the exception came from.
salt will be able to show you a stack trace that lets you see exactly where the exception came from.
The exception
<i>
forces
</i>
you, the user, to
The exception
<i>
forces
</i>
you, the user, to
be aware of this potential error and to add a catch block to deal with it.
be aware of this potential error and to add a catch block to deal with it.
This is where the "hard to use wrong" comes from.
This is where the "hard to use wrong" comes from.
...
...
docs/docs/intro.xml
View file @
992175a6
...
@@ -120,8 +120,8 @@
...
@@ -120,8 +120,8 @@
broken rather than causing "undefined results")
broken rather than causing "undefined results")
<br/><br/><u>
ensures
</u>
: This defines what the function does. It is a list of conditions that will be
<br/><br/><u>
ensures
</u>
: This defines what the function does. It is a list of conditions that will be
true after the function finishes executing. Note that if an exception is thrown
or the function returns
true after the function finishes executing. Note that if an exception is thrown
then nothing in the
indicating an error occurred then nothing in the
ensures clause is guaranteed to be true.
ensures clause is guaranteed to be true.
<br/><br/><u>
throws
</u>
: This defines what exceptions may be thrown by this function. It generally
<br/><br/><u>
throws
</u>
: This defines what exceptions may be thrown by this function. It generally
tells you why the exception might be thrown. It also tells you what the function does in this event:
tells you why the exception might be thrown. It also tells you what the function does in this event:
...
@@ -167,8 +167,8 @@
...
@@ -167,8 +167,8 @@
- something
>
4
- something
>
4
ensures
ensures
- #some_other_function() == 9
- #some_other_function() == 9
- #funct() == something
- #something == something + 1
- #something == something + 1
- returns something
!*/
</font>
!*/
</font>
</code_box>
</code_box>
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment