From 8782a6202cf9fa623d0295fe04f661ddfe17e4ac Mon Sep 17 00:00:00 2001 From: Kjetil Olsen Lye Date: Wed, 25 Apr 2012 16:45:32 +0200 Subject: [PATCH] Added some more documentation --- opm/core/WellsGroup.cpp | 2 +- opm/core/WellsGroup.hpp | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/opm/core/WellsGroup.cpp b/opm/core/WellsGroup.cpp index 6c8649a6..e1f198f3 100644 --- a/opm/core/WellsGroup.cpp +++ b/opm/core/WellsGroup.cpp @@ -456,7 +456,7 @@ namespace Opm } } // anonymous namespace - std::tr1::shared_ptr createWellsGroup(std::string name, const EclipseGridParser& deck) + std::tr1::shared_ptr createWellsGroup(const std::string& name, const EclipseGridParser& deck) { std::tr1::shared_ptr return_value; diff --git a/opm/core/WellsGroup.hpp b/opm/core/WellsGroup.hpp index 5cf1ae74..f31f3aff 100644 --- a/opm/core/WellsGroup.hpp +++ b/opm/core/WellsGroup.hpp @@ -178,8 +178,10 @@ namespace Opm int self_index_; }; - /// Doc me! - std::tr1::shared_ptr createWellsGroup(std::string name, + /// Creates the WellsGroupInterface for the given name + /// \param[in] name the name of the wells group. + /// \param[in] deck the deck from which to fetch information. + std::tr1::shared_ptr createWellsGroup(const std::string& name, const EclipseGridParser& deck);