]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add documentation to the zlib compression levels. 3650/head
authorDavid Wells <wellsd2@rpi.edu>
Wed, 30 Nov 2016 19:05:13 +0000 (14:05 -0500)
committerDavid Wells <wellsd2@rpi.edu>
Wed, 30 Nov 2016 22:39:04 +0000 (17:39 -0500)
Enumerations are not listed by doxygen unless they have documentation
strings, so add them.

include/deal.II/base/data_out_base.h

index 813f51d1d0e463bfd1be8ab42fc58b9fc41adcc5..f2f6476a299803be06baee2fde905049594596a5 100644 (file)
@@ -947,13 +947,28 @@ namespace DataOutBase
     bool print_date_and_time;
 
     /**
-     * A data type providing the different possible zlib compression levels.
+     * A data type providing the different possible zlib compression
+     * levels. These map directly to constants defined by zlib.
      */
     enum ZlibCompressionLevel
     {
+      /**
+       * Do not use any compression.
+       */
       no_compression,
+      /**
+       * Use the fastest available compression algorithm.
+       */
       best_speed,
+      /**
+       * Use the algorithm which results in the smallest compressed
+       * files. This is the default flag.
+       */
       best_compression,
+      /**
+       * Use the default compression algorithm. This is a compromise between
+       * speed and file size.
+       */
       default_compression
     };
 

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.