Commit 319ba479 authored by Jason Rhinelander's avatar Jason Rhinelander

Documentation fixes: `code' => `code`

parent 6be16ede
......@@ -147,7 +147,7 @@ class Random final {
* return a random draw from the untruncated distribution, and has a `result_type` member
* agreeing with `dist::value_type`. This generator is only used if the given min and max
* don't actually truncate the distribution (for example, when attempting to draw a
* "truncated" normal with truncation range `[-infinity,infinity]`. Both boost's random
* "truncated" normal with truncation range \f$[-\infty,\infty]\f$. Both boost's random
* number generators and the C++11 random number generators are suitable.
*
* \param min the truncated region lower bound
......
......@@ -185,19 +185,19 @@ class Simulation final : public std::enable_shared_from_this<Simulation>, privat
>::type>
size_t countOthers(const std::function<bool(const O &good)> &filter = nullptr) const;
/** Records already-stored member `depends_on' as a dependency of `member'. If `depends_on'
* is removed from the simulation, `member' will be automatically removed as well.
/** Records already-stored member `depends_on` as a dependency of `member`. If `depends_on`
* is removed from the simulation, `member` will be automatically removed as well.
*
* Note that dependents are removed *after* removal of their dependencies. That is, if A
* depends on B, and B is removed, the B removal occurs *first*, followed by the A removal.
*/
void registerDependency(eris_id_t member, eris_id_t depends_on);
/** Records already-stored member `depends_on' is a weak dependency of `member'. In
/** Records already-stored member `depends_on` is a weak dependency of `member`. In
* contrast to a non-weak dependency, the member is only notified of the removal of the
* dependent, it is not removed itself.
*
* When `depends_on' is removed from the simulation, `member' will have its depRemoved()
* When `depends_on` is removed from the simulation, `member` will have its depRemoved()
* method called with the just-removed (but still not destroyed) member.
*/
void registerWeakDependency(eris_id_t member, eris_id_t depends_on);
......
......@@ -39,7 +39,7 @@ namespace eris {
* be necessary at all, since it is obtainable from the class of the given iterator, but gcc
* (as of 4.8.1) chokes on that, hence the additional (required) template parameter.
*/
// FIXME: this first 'T' template parameter shouldn't be needed (and isn't, if using clang++), but
// FIXME: this first `T` template parameter shouldn't be needed (and isn't, if using clang++), but
// g++ needs it, so everything has to deal with it. Try again, eventually, to remove it, changing
// the 'T' types below to 'typename It::value_type'.
template <typename T, typename It>
......@@ -231,7 +231,7 @@ class Stepper final {
* count of previous steps in this direction is halved); if the last step was in the
* opposite direction, the step size is halved.
*
* After this is called, you may optionally consider the `oscillating_min' value, which will
* After this is called, you may optionally consider the `oscillating_min` value, which will
* tell you how many of the previous steps have simply oscillated around the minimum step
* size (and thus aren't doing anything useful).
*/
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment