]> https://gitweb.dealii.org/ - dealii.git/commitdiff
added input parameter description for start_step() function in TimeStepControl class
authorJoshua Hansel <joshua.hansel89@gmail.com>
Tue, 4 Aug 2015 20:08:00 +0000 (14:08 -0600)
committerJoshua Hansel <joshua.hansel89@gmail.com>
Tue, 4 Aug 2015 20:08:00 +0000 (14:08 -0600)
include/deal.II/algorithms/timestep_control.h

index 6386cf59d33f1bcaaed80b9f399bf8dc61309f60..ae1ad5f58949e00229b336644c7482d68dd3b6ce 100644 (file)
@@ -139,8 +139,11 @@ namespace Algorithms
     /**
      * Set size of the first step. This may be overwritten by the time
      * stepping strategy.
+     *
+     * @param[in] step The size of the first step, which may be overwritten by
+     *   the time stepping strategy.
      */
-    void start_step (double);
+    void start_step (double step);
 
     /**
      * Set size of the maximum step size.

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.