From: David Wells <wellsd2@rpi.edu>
Date: Wed, 30 Nov 2016 19:05:13 +0000 (-0500)
Subject: Add documentation to the zlib compression levels.
X-Git-Tag: v8.5.0-rc1~351^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7613b0a1da409aa3cc615078cf9b709a4c4e038b;p=dealii.git

Add documentation to the zlib compression levels.

Enumerations are not listed by doxygen unless they have documentation
strings, so add them.
---

diff --git a/include/deal.II/base/data_out_base.h b/include/deal.II/base/data_out_base.h
index 813f51d1d0..f2f6476a29 100644
--- a/include/deal.II/base/data_out_base.h
+++ b/include/deal.II/base/data_out_base.h
@@ -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
     };