Added some more documentation

This commit is contained in:
Kjetil Olsen Lye 2012-04-25 16:45:32 +02:00
parent 38c02c5a63
commit 743085bd16
2 changed files with 5 additions and 3 deletions

View File

@ -456,7 +456,7 @@ namespace Opm
}
} // anonymous namespace
std::tr1::shared_ptr<WellsGroupInterface> createWellsGroup(std::string name, const EclipseGridParser& deck)
std::tr1::shared_ptr<WellsGroupInterface> createWellsGroup(const std::string& name, const EclipseGridParser& deck)
{
std::tr1::shared_ptr<WellsGroupInterface> return_value;

View File

@ -178,8 +178,10 @@ namespace Opm
int self_index_;
};
/// Doc me!
std::tr1::shared_ptr<WellsGroupInterface> 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<WellsGroupInterface> createWellsGroup(const std::string& name,
const EclipseGridParser& deck);