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 8b7f034dd94f7e6133c32247bdbd3627a7e07937..d133c885be50d40ead2542038958256312aa045a 100644 (file)
--- 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;
     };