From b5fab408c065b6d88f6eff7255f3d1e168168309 Mon Sep 17 00:00:00 2001 From: tcclevenger Date: Wed, 30 Nov 2016 23:12:14 -0500 Subject: [PATCH] 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 --- include/deal.II/base/utilities.h | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) 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; }; -- 2.39.5