]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Augment docs.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 14 May 2008 14:54:55 +0000 (14:54 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 14 May 2008 14:54:55 +0000 (14:54 +0000)
git-svn-id: https://svn.dealii.org/trunk@16091 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/utilities.h

index 08472cb133670f511db9266c2a9f2cb4eedb6ffe..04fd5710674af4f9c38e30b408064b20c58a485d 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 2005, 2006, 2007 by the deal.II authors
+//    Copyright (C) 2005, 2006, 2007, 2008 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -45,6 +45,12 @@ namespace Utilities
                                     * Convert a number @p i to a string, with
                                     * as many digits as given to fill with
                                     * leading zeros.
+                                   *
+                                   * If the second parameter is left at its
+                                   * default value, the number is not padded
+                                   * with leading zeros. The result is then
+                                   * the same as of the standard C function
+                                   * <code>itoa()</code> had been called.
                                     */
   std::string
   int_to_string (const unsigned int i,

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.