diff options
author | Magnus Lundborg <lundborg.magnus@gmail.com> | 2012-12-12 19:01:22 (GMT) |
---|---|---|
committer | Magnus Lundborg <lundborg.magnus@gmail.com> | 2012-12-12 19:01:22 (GMT) |
commit | dee216e4f18fef0ad0f9120ce552aab44f5af36d (patch) | |
tree | 1583b55fd498d80bad59518baf6f5fc25976423f /src/lib/tng_io.h | |
parent | 73856b99d93656561f0ec039dea19b81f78a2762 (diff) |
Improved comments. Minor cleanups.
Diffstat (limited to 'src/lib/tng_io.h')
-rw-r--r-- | src/lib/tng_io.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/lib/tng_io.h b/src/lib/tng_io.h index 804ab5c..6403374 100644 --- a/src/lib/tng_io.h +++ b/src/lib/tng_io.h @@ -898,6 +898,8 @@ tng_function_status tng_frame_set_new(tng_trajectory_t tng_data, * data block * @param codec_id is the ID of the codec to compress the data. * @param new_data is an array of data values to add. + * @return TNG_SUCCESS (0) if successful, TNG_FAILURE (1) if a minor error + * has occurred or TNG_CRITICAL (2) if a major error has occured. */ tng_function_status tng_data_block_add(tng_trajectory_t tng_data, const int64_t id, @@ -932,6 +934,8 @@ tng_function_status tng_data_block_add(tng_trajectory_t tng_data, * @param n_particles is the number of particles stored in this data block * @param codec_id is the ID of the codec to compress the data. * @param new_data is an array of data values to add. + * @return TNG_SUCCESS (0) if successful, TNG_FAILURE (1) if a minor error + * has occurred or TNG_CRITICAL (2) if a major error has occured. */ tng_function_status tng_particle_data_block_add(tng_trajectory_t tng_data, const int64_t id, |