From ea840aa7d69a5b247f6b06f6308013d4428bff86 Mon Sep 17 00:00:00 2001
From: Carlo Camilloni <carlo.camilloni@gmail.com>
Date: Mon, 2 Jun 2014 09:13:44 +0100
Subject: [PATCH] documentation fixes
---
src/analysis/Histogram.cpp | 4 +++-
src/bias/LWalls.cpp | 2 +-
src/bias/UWalls.cpp | 2 +-
3 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/src/analysis/Histogram.cpp b/src/analysis/Histogram.cpp
index 979d5c94f..394cedbfd 100644
--- a/src/analysis/Histogram.cpp
+++ b/src/analysis/Histogram.cpp
@@ -33,7 +33,9 @@ namespace analysis{
//+PLUMEDOC ANALYSIS HISTOGRAM
/*
Calculate the probability density as a function of a few CVs either using kernel density estimation, or a discrete
-histogram estimation. In case a kernel density estimation is used the probability density is estimated as a
+histogram estimation.
+
+In case a kernel density estimation is used the probability density is estimated as a
continuos function on the grid with a BANDWIDTH defined by the user. In this case the normalisation is such that
the INTEGRAL over the grid is 1. In case a discrete density estimation is used the probabilty density is estimated
as a discrete function on the grid. In this case the normalisation is such that the SUM of over the grid is 1.
diff --git a/src/bias/LWalls.cpp b/src/bias/LWalls.cpp
index 0337fa867..dfbffa7fb 100644
--- a/src/bias/LWalls.cpp
+++ b/src/bias/LWalls.cpp
@@ -31,7 +31,7 @@ namespace bias{
//+PLUMEDOC BIAS LOWER_WALLS
/*
-The LOWER_WALLS and UPPER_WALLS keywords define a wall for the value of one or more collective variables,
+Defines a wall for the value of one or more collective variables,
which limits the region of the phase space accessible during the simulation.
The restraining potential starts acting on the system when the value of the CV is greater
diff --git a/src/bias/UWalls.cpp b/src/bias/UWalls.cpp
index 9e4e8d95f..5d5e78668 100644
--- a/src/bias/UWalls.cpp
+++ b/src/bias/UWalls.cpp
@@ -31,7 +31,7 @@ namespace bias{
//+PLUMEDOC BIAS UPPER_WALLS
/*
-The LOWER_WALLS and UPPER_WALLS keywords define a wall for the value of one or more collective variables,
+Defines a wall for the value of one or more collective variables,
which limits the region of the phase space accessible during the simulation.
The restraining potential starts acting on the system when the value of the CV is greater
--
GitLab