From: tcclevenger <tcleven@clemson.edu>
Date: Thu, 1 Dec 2016 04:12:14 +0000 (-0500)
Subject: Fixed documentation for Utilities::System::MemoryStats Struct Reference
X-Git-Tag: v8.5.0-rc1~348^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F3651%2Fhead;p=dealii.git

Fixed documentation for Utilities::System::MemoryStats Struct Reference

Comments in deal.II/base/utilities.h were behind variable declarations
leading to wrong placement in online documentation
---

diff --git a/include/deal.II/base/utilities.h b/include/deal.II/base/utilities.h
index 8b7f034dd9..d133c885be 100644
--- a/include/deal.II/base/utilities.h
+++ b/include/deal.II/base/utilities.h
@@ -389,10 +389,25 @@ namespace Utilities
      */
     struct MemoryStats
     {
-      unsigned long int VmPeak; /** peak virtual memory size in kB */
-      unsigned long int VmSize; /** current virtual memory size in kB */
-      unsigned long int VmHWM; /** peak resident memory size in kB */
-      unsigned long int VmRSS; /** current resident memory size in kB */
+      /**
+       * Peak virtual memory size in kB.
+       */
+      unsigned long int VmPeak;
+
+      /**
+       * Current virtual memory size in kB.
+       */
+      unsigned long int VmSize;
+
+      /**
+       * Peak resident memory size in kB. Also known as "high water mark" (HWM).
+       */
+      unsigned long int VmHWM;
+
+      /**
+       * Current resident memory size in kB. Also known as "resident set size" (RSS).
+       */
+      unsigned long int VmRSS;
     };