From c6c1f08bd75a1ca48ee4129e7384e84583b7a85d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A5rd=20Skaflestad?= Date: Sun, 22 Apr 2012 17:03:13 +0200 Subject: [PATCH] Fix cross-reference misprint in destroy_wells() documentation. --- opm/core/newwells.h | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/opm/core/newwells.h b/opm/core/newwells.h index fa9a737e..2df51a19 100644 --- a/opm/core/newwells.h +++ b/opm/core/newwells.h @@ -190,9 +190,13 @@ void clear_well_controls(struct WellControls *ctrl); -/** Destruction function for Wells objects. - * Assumes that create_wells() and add_wells() have been used to - * build the object. +/** + * Wells object destructor. + * + * Disposes of all resources managed by the Wells object. + * + * The Wells object must be built using function create_wells() and + * subsequently populated using function add_well(). */ void destroy_wells(struct Wells *W);