X-Git-Url: https://git.dlugolecki.net.pl/?a=blobdiff_plain;f=src%2Fstorage%2Fpositions.h;h=6f96b90c50126ef93bfd7738fc1f523baa2574ba;hb=53d9ddd557f5c7543a14402a2a01b0119eadbbfa;hp=2d3473e8436afb37f4bbbb0079f9b211e9e26317;hpb=46c09ea2689913bb459c5f04439647aa138dc196;p=familia.git diff --git a/src/storage/positions.h b/src/storage/positions.h index 2d3473e..6f96b90 100644 --- a/src/storage/positions.h +++ b/src/storage/positions.h @@ -25,30 +25,36 @@ #include "individual.h" #include "family.h" +/** + * @file storage/positions.h + * @brief Code for managing 3D positions of objects. + * + */ + /** * Sets position for the given individual. - * @parameter individual individual to set the position - * @parameter position position which will be used for individual + * @param individual individual to set the position + * @param pos position which will be used for individual */ void familia_positions_set_individual_position(struct familia_individual *individual, struct position *pos); /** * Sets position for the given family. - * @parameter family family to set the position - * @parameter position position which will be used for family + * @param family family to set the position + * @param pos position which will be used for family */ void familia_positions_set_family_position(struct familia_family *family, struct position *pos); /** * Gets position of the given individual. - * @parameter individual individual for which the position will be get + * @param individual individual for which the position will be get * @return position of the individual or NULL on error */ struct position * familia_position_get_individual_position(struct familia_individual *individual); /** * Gets position of the given family - * @parameter family family for which the position will be get + * @param family family for which the position will be get * @return position of the family or NULL on error */ struct position * familia_position_get_family_position(struct familia_family *family);