Finally made a initial doxygen documentation pass over all files.

1 files changed, 5 insertions, 5 deletions

diff --git a/libcmix/cmix.h b/libcmix/cmix.h
index 517f067..4a4441b 100644
--- a/libcmix/cmix.h
+++ b/libcmix/cmix.h
@@ -2,7 +2,7 @@
 extern "C" {
 #endif
 
-/**
+/*!
  * \file
  */
 
@@ -17,7 +17,7 @@ struct CMixBuffer {
 	unsigned int message_length; ///< The length of each message in the buffer
 };
 
-/**
+/*!
  * \brief The cmix_error enum describes the output state of a each of the cmix functions
  */
 enum cmix_error {
@@ -25,14 +25,14 @@ enum cmix_error {
 	index_out_of_range = 1000
 };
 
-/**
+/*!
  * \brief permutate mixes the messages before sending the messages.
  * \param[in,out] b A buffer of \p nr_messages messages, each message of length *message_len*
  * \return no_error
  */
 enum cmix_error permute(struct CMixBuffer b);
  
-/**
+/*!
  * \brief get_message takes the \p index message of the buffer \p b copies it into \p message 
  * \param[out] message is the output buffer that has to hold at least \p b.message_length bytes.
  * \param[in] b is the buffer from which to copy the message.
@@ -41,7 +41,7 @@ enum cmix_error permute(struct CMixBuffer b);
  */
 enum cmix_error get_message(char* message, struct CMixBuffer b, unsigned int index);
 
-/**
+/*!
  * \brief set_message set the \p index message of the buffer to a copy of \p message.
  * \param[in] message The message to set the part of the buffer to.
  * \param[in,out] b The buffer