Refine description of allocate_grid() return value.

Specifically, the "global_cell" field remains unallocated (i.e.,
NULL) while other fields have undetermined contents.
This commit is contained in:
Bård Skaflestad
2012-06-11 18:52:44 +02:00
parent bf0e469cf5
commit 54a993e99d

View File

@@ -261,9 +261,9 @@ create_grid_empty(void);
(i.e., the number of `half-faces')
\param[in] nnodes Number of Nodes.
\return Fully formed UnstructuredGrid with all fields allocated,
but not filled with usefull numbers. <code>NULL</code> in case of
allocation failure.
\return Fully formed UnstructuredGrid with all fields except
<code>global_cell</code> allocated, but not filled with meaningful
values. <code>NULL</code> in case of allocation failure.
*/
struct UnstructuredGrid *
allocate_grid(size_t ndims ,