diff options
author | Magnus Lundborg <lundborg.magnus@gmail.com> | 2013-10-30 07:26:05 (GMT) |
---|---|---|
committer | Magnus Lundborg <lundborg.magnus@gmail.com> | 2013-10-30 07:46:17 (GMT) |
commit | 59632d68300be2af11c334b42b668fc4669b7671 (patch) | |
tree | 1bc9a37d4340ec757afedc5d0220617bc71c7408 /include | |
parent | bb465175362766009433696506dab621c854bc78 (diff) |
Fixed mistake in documentation.
Diffstat (limited to 'include')
-rw-r--r-- | include/tng_io.h | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/include/tng_io.h b/include/tng_io.h index 1b29fbf..c31d8a2 100644 --- a/include/tng_io.h +++ b/include/tng_io.h @@ -1464,12 +1464,10 @@ tng_function_status DECLSPECDLLEXPORT tng_residue_name_of_particle_nr_get int max_len); /** - * @brief Get the residue name of real particle number (number in mol system). + * @brief Get the residue id of real particle number (number in mol system). * @param tng_data is the trajectory data container containing the atom. * @param nr is the real number of the particle in the molecular system. - * @param name is a string, which is set to the name of the residue. Memory - * must be reserved beforehand. - * @param max_len is the maximum length of name. + * @param id is a pointer to the variable, which will be set to the ID. * @return TNG_SUCCESS (0) if successful or TNG_FAILURE (!) if a minor error * has occured. */ |