From 29220048741c7ab7d578a67ec8e65465fa1495bd Mon Sep 17 00:00:00 2001 From: bangerth Date: Wed, 2 Jun 2010 18:32:27 +0000 Subject: [PATCH] Change markup slightly. This helps avoid a broken link in doxygen. git-svn-id: https://svn.dealii.org/trunk@21147 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/event.h | 74 +++++++++++++++++++------------ 1 file changed, 46 insertions(+), 28 deletions(-) diff --git a/deal.II/base/include/base/event.h b/deal.II/base/include/base/event.h index 84f5bd51da..9fcf56bf74 100644 --- a/deal.II/base/include/base/event.h +++ b/deal.II/base/include/base/event.h @@ -32,14 +32,14 @@ namespace Algorithms * Event is organized as an extensible binary enumerator. Every class * can add its own events using assign(). A typical code example is * - *
+ * @code
  * class A
  * {
  *   static Event event;
  * };
  *
  * Event A::event = Event::assign("Event for A");
- * 
+ * @endcode */ class Event { @@ -61,7 +61,7 @@ namespace Algorithms * the name. */ // static Event find(const std::string& name); - + /** * Constructor, generating a * clear Event. @@ -112,7 +112,7 @@ namespace Algorithms */ template static void print_assigned (OS& os); - + private: /** * Sometimes, actions have to @@ -122,31 +122,49 @@ namespace Algorithms * returns true. */ bool all_true; - + /** * The actual list of events */ std::vector flags; - + /** * The names of registered events */ static std::vector names; }; -/// Events used by library operators +/** + * Events used by library operators + */ namespace Events { -/// The program has just started and everything should be new + /** + * The program has just started + * and everything should be + * new. + */ extern const Event initial; -/// The current derivative leads to slow convergence of Newton's method + + /** + * The current derivative leads + * to slow convergence of + * Newton's method. + */ extern const Event bad_derivative; -/// The time stepping scheme starts a new time step + + /** + * The time stepping scheme + * starts a new time step. + */ extern const Event new_time; -/// The time stepping scheme has changed the time step size + + /** + * The time stepping scheme has changed the time step size. + */ extern const Event new_timestep_size; } - + //----------------------------------------------------------------------// @@ -167,14 +185,14 @@ namespace Algorithms bool Event::test (const Event& event) const { - + // First, test all_true in this if (all_true) return true; - + const unsigned int n = flags.size(); const unsigned int m = event.flags.size(); const unsigned int n_min = std::min(n, m); - + // Now, if all_true set in the // other, then all must be true // in this @@ -205,15 +223,15 @@ namespace Algorithms return false; return true; } - - + + inline Event& Event::operator += (const Event& event) { all_true |= event.all_true; if (all_true) return *this; - + if (flags.size() < event.flags.size()) flags.resize(event.flags.size()); for (unsigned int i=0;i inline @@ -253,13 +271,13 @@ namespace Algorithms { if (all_true) os << " ALL"; - + for (unsigned int i=0;i inline void @@ -268,8 +286,8 @@ namespace Algorithms for (unsigned int i=0;i