Fixed documentation generation in some files.

diff --git a/src/math/positions.h b/src/math/positions.h
index c5a4fa4424d4eecfa61629769a36b6af2bfe08d9..878616e141720fe244b967c3a26a16bc053c7ee1 100644 (file)
--- a/src/math/positions.h
+++ b/src/math/positions.h
@@ -32,16 +32,22 @@ struct objects_boundaries {
        double left;
 };
 
+/**
+ * @file math/positions.h
+ * @brief Code for calculating 3D positions of objects.
+ *
+ */
+
 /**
  * Calculates local position of given individual
- * @parameter individual to calculate position
+ * @param individual individual to calculate position
  * @return calculated local position of the individual
  */
 struct position * calculate_individual_position(struct familia_individual * individual);
 
 /**
  * Calculates local position of given family
- * @parameter family to calculate position
+ * @param family family to calculate position
  * @return calculated local position of the family
  */
 struct position * calculate_family_position(struct familia_family * family);

diff --git a/src/storage/family.h b/src/storage/family.h
index adf2dac5502daca279cf5375c2d34b7ce6d82abc..96544e196c4f09dfa331b1114636af0884b33d77 100644 (file)
--- a/src/storage/family.h
+++ b/src/storage/family.h
@@ -22,6 +22,12 @@
 
 #include "individual.h"
 
+/**
+ * @file storage/family.h
+ * @brief Code for managing families.
+ *
+ */
+
 enum FFamilyIndividualIndex {
        Individual1,
        Individual2
@@ -48,40 +54,41 @@ struct familia_family {
 };
 
 /**
- * Creates new family structure
- * @return Newly allocated individual.If allocation failed, returns NULL, like
+ * Creates new family structure.
+ * @return Newly allocated @ref familia_family. If allocation failed, returns NULL, like
  *         malloc.
  */
 struct familia_family * familia_family_new();
 
 /**
- * Frees allocated memory of the given family
- * DISCLAIMER! This function does not free memory of linked individuals. You have to
- * remove them manually from storage.
- * @parameter individual free
+ * Frees allocated memory of the given family.
+ * @attention This function does not free memory of linked individuals. You have to
+ * remove them manually from @ref familia_storage, by using @ref familia_storage_free.
+ * @param family family to free
  */
 void familia_family_free(struct familia_family * family);
 
 /**
- * Sets individual1 in the given family
- * @parameter family to set the individual
- * @parameter individual which will be set
+ * Sets parent in the given family.
+ * @param family family to set the parent
+ * @param individual individual which will be a parent in family
+ * @param index individual type which will be set
  */
 void familia_family_set_parent(struct familia_family * family, struct familia_individual * individual, enum FFamilyIndividualIndex index);
 
 /**
- * Gets individual from the given family
- * @parameter family to get the individual
- * @parameter individual index of which individual get
+ * Gets parent from the given family.
+ * @param family family to get the individual
+ * @param index individual index of which individual get
  */
 struct familia_individual * familia_family_get_parent(struct familia_family * family, enum FFamilyIndividualIndex index);
 
 /**
- * Removes individual from the given family
- * DISCLAIMER! This function does not free memory of linked individuals. You have to
- * remove them manually from storage.
- * @parameter family to remove the individual
- * @parameter individual index of which individual to remove
+ * Removes parent from the given family
+ * @attention This function does not free memory of linked individuals. You have to
+ * remove them manually from @ref familia_storage, by using @ref familia_storage_free.
+ * @param family family to remove the individual
+ * @param index individual index of which individual to remove
  * @return returns removed individual, NULL if such does not exist.
  */
 struct familia_individual * familia_family_remove_parent(struct familia_family * family, enum FFamilyIndividualIndex index);
@@ -90,16 +97,16 @@ struct familia_individual * familia_family_remove_parent(struct familia_family *
  * Adds new child in the given family
  * Automatically sets family as parents in individual variable.
  *
- * @parameter family to set the individual
- * @parameter individual which will be added
+ * @param family family to set the individual
+ * @param individual individual which will be added
  */
 void familia_family_add_child(struct familia_family * family, struct familia_individual * individual);
 
 /**
  * Gets the nth child from the given family
  * Child with index = 0 is the oldest. Bigger the index, the child is younger
- * @parameter family to get the child
- * @parameter individual index of which individual get
+ * @param family family to get the child
+ * @param index individual index of which individual get
  * @return selected child. If index is bigger than child_no of the family
  *         returns NULL.
  */
@@ -107,10 +114,10 @@ struct familia_individual * familia_family_get_child_by_id(struct familia_family
 
 /**
  * Removes child from the given family
- * DISCLAIMER! This function does not free memory of linked children. You have to
- * remove them manually from storage.
- * @parameter family to remove the child
- * @parameter index of which child should be removed
+ * @attention This function does not free memory of linked children. You have to
+ * remove them manually from @ref familia_storage, by using @ref familia_storage_free.
+ * @param family family to remove the child
+ * @param index index of which child should be removed
  * @return removed child. If such does not exist or index is bigger than child_no
  *         of the family, returns NULL.
  */

diff --git a/src/storage/positions.h b/src/storage/positions.h
index 2d3473e8436afb37f4bbbb0079f9b211e9e26317..6f96b90c50126ef93bfd7738fc1f523baa2574ba 100644 (file)
--- 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);

diff --git a/src/ui/scrollbars.h b/src/ui/scrollbars.h
index 11df742b2361fb40f2056eefc7cf0b86f75e12e5..b4d8bb6f34480ddf589c68ce2587f359e666d21c 100644 (file)
--- a/src/ui/scrollbars.h
+++ b/src/ui/scrollbars.h
@@ -22,6 +22,12 @@
 
 #include <gtk/gtk.h>
 
+/**
+ * @file ui/scrollbars.h
+ * @brief Code for connecting scrollbars to the application.
+ *
+ */
+
 /**
  * Maintains changes in properties in main horizontal scrollbar.
  *