From 6ac3c58e6d6af0b01541160c2bccf776269f504e Mon Sep 17 00:00:00 2001
From: Gareth Tribello <gareth.tribello@gmail.com>
Date: Sat, 22 Oct 2016 19:05:10 +0100
Subject: [PATCH] Added small ammount of documentation to undocumented actions
---
src/adjmat/DumpGraph.cpp | 10 ++++++++++
src/adjmat/TopologyMatrix.cpp | 8 ++++++++
src/gridtools/IntegrateGrid.cpp | 9 +++++++++
3 files changed, 27 insertions(+)
diff --git a/src/adjmat/DumpGraph.cpp b/src/adjmat/DumpGraph.cpp
index 2d364176b..971cb91e2 100644
--- a/src/adjmat/DumpGraph.cpp
+++ b/src/adjmat/DumpGraph.cpp
@@ -30,6 +30,16 @@
namespace PLMD {
namespace adjmat {
+//+PLUMEDOC CONCOMP DUMPGRAPH
+/*
+Write out the connnectivity of the nodes in the graph in dot format.
+
+\par Examples
+
+*/
+//+ENDPLUMEDOC
+
+
class DumpGraph : public ActionPilot {
private:
///
diff --git a/src/adjmat/TopologyMatrix.cpp b/src/adjmat/TopologyMatrix.cpp
index 96071c4ac..68f208bd4 100644
--- a/src/adjmat/TopologyMatrix.cpp
+++ b/src/adjmat/TopologyMatrix.cpp
@@ -26,6 +26,14 @@
#include "tools/HistogramBead.h"
#include "tools/Matrix.h"
+//+PLUMEDOC MATRIX TOPOLOGY_MATRIX
+/*
+Adjacency matrix in which two atoms are adjacent if they are connected topologically
+
+\par Examples
+
+*/
+//+ENDPLUMEDOC
namespace PLMD {
namespace adjmat {
diff --git a/src/gridtools/IntegrateGrid.cpp b/src/gridtools/IntegrateGrid.cpp
index 11538cc3a..d5eac3f0f 100644
--- a/src/gridtools/IntegrateGrid.cpp
+++ b/src/gridtools/IntegrateGrid.cpp
@@ -22,6 +22,15 @@
#include "core/ActionRegister.h"
#include "ActionWithIntegral.h"
+//+PLUMEDOC GRIDANALYSIS INTEGRATE_GRID
+/*
+Calculate the total integral of the function on the input grid
+
+\par Examples
+
+*/
+//+ENDPLUMEDOC
+
namespace PLMD {
namespace gridtools {
--
GitLab