Use doxygen headers for src/util files

FreeRADIUS · Nov 25, 2016 · 0847a26 · 0847a26
1 parent 6eaa5cb
commit 0847a26
Show file tree

Hide file tree

Showing 8 changed files with 61 additions and 41 deletions.
diff --git a/src/util/atomic_queue.c b/src/util/atomic_queue.c
@@ -18,12 +18,11 @@
  * $Id$
  *
  * @brief Thread-safe queues.
- * @file atomic_queue.c
+ * @file util/atomic_queue.c
  *
  * @copyright 2016 Alan DeKok <aland@freeradius.org>
  * @copyright 2016 Alister Winfield
  */
-
 RCSID("$Id$")
 
 #include <stdint.h>

diff --git a/src/util/channel.c b/src/util/channel.c
@@ -1,8 +1,4 @@
 /*
- * channel.c	Two-way thread-safe channels
- *
- * Version:	$Id$
- *
  *   This program is free software; you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
  *   the Free Software Foundation; either version 2 of the License, or
@@ -16,8 +12,15 @@
  *   You should have received a copy of the GNU General Public License
  *   along with this program; if not, write to the Free Software
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+/**
+ * $Id$
+ *
+ * @brief Two-way thread-safe channels
+ * @file util/channel.c
  *
- * Copyright 2016  Alan DeKok <aland@freeradius.org>
+ * @copyright 2016 Alan DeKok <aland@freeradius.org>
  */
 RCSID("$Id$")
 
@@ -203,7 +206,7 @@ int fr_channel_send_request(fr_channel_t *ch, fr_channel_data_t *cd, fr_channel_
 
 	rad_assert(end->last_write <= when);
 	end->last_write = when;
-	
+
 	/*
 	 *	Increment the number of outstanding packets.  If we
 	 *	just sent a new one, wake up the other end.
@@ -343,7 +346,7 @@ int fr_channel_send_reply(fr_channel_t *ch, fr_channel_data_t *cd, fr_channel_da
 		*p_request = fr_channel_recv_request(ch);
 		return -1;
 	}
-	
+
 	rad_assert(end->num_outstanding > 0);
 	end->num_outstanding--;
 

diff --git a/src/util/message.c b/src/util/message.c
@@ -1,8 +1,4 @@
 /*
- * message.c	Messages for inter-thread communication.
- *
- * Version:	$Id$
- *
  *   This program is free software; you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
  *   the Free Software Foundation; either version 2 of the License, or
@@ -16,8 +12,15 @@
  *   You should have received a copy of the GNU General Public License
  *   along with this program; if not, write to the Free Software
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+/**
+ * $Id$
+ *
+ * @brief Messages for inter-thread communication
+ * @file util/message.c
  *
- * Copyright 2016  Alan DeKok <aland@freeradius.org>
+ * @copyright 2016 Alan DeKok <aland@freeradius.org>
  */
 RCSID("$Id$")
 
@@ -666,7 +669,7 @@ static void fr_message_gc(fr_message_set_t *ms, int max_to_clean)
  * The newly allocated message is zeroed.
  *
  * @param[in] ms the message set
- * @param[in] mr the message ring to allocate from 
+ * @param[in] mr the message ring to allocate from
  * @param[in] clean whether to clean the message ring
  * @return
  *	- NULL on failed allocation
@@ -1304,7 +1307,7 @@ fr_message_t *fr_message_alloc_aligned(fr_message_set_t *ms, fr_message_t *m, si
 	uint8_t *p, *aligned_p;
 	intptr_t addr;
 	size_t aligned_size;
-	
+
 
 #ifndef NDEBUG
 	(void) talloc_get_type_abort(ms, fr_message_set_t);

diff --git a/src/util/queue.c b/src/util/queue.c
@@ -1,8 +1,4 @@
 /*
- * queue.c	Thread-unsafe queues.
- *
- * Version:	$Id$
- *
  *   This program is free software; you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
  *   the Free Software Foundation; either version 2 of the License, or
@@ -16,8 +12,15 @@
  *   You should have received a copy of the GNU General Public License
  *   along with this program; if not, write to the Free Software
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+/**
+ * $Id$
+ *
+ * @brief Thread-unsafe queues
+ * @file util/queue.c
  *
- * Copyright 2016  Alan DeKok <aland@freeradius.org>
+ * @copyright 2016 Alan DeKok <aland@freeradius.org>
  */
 RCSID("$Id$")
 

diff --git a/src/util/ring_buffer.c b/src/util/ring_buffer.c
@@ -1,8 +1,4 @@
 /*
- * ring_buffer.c	Simple ring buffers for packet contents.
- *
- * Version:	$Id$
- *
  *   This program is free software; you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
  *   the Free Software Foundation; either version 2 of the License, or
@@ -16,8 +12,15 @@
  *   You should have received a copy of the GNU General Public License
  *   along with this program; if not, write to the Free Software
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+/**
+ * $Id$
+ *
+ * @brief Simple ring buffers for packet contents
+ * @file util/ring_buffer.c
  *
- * Copyright 2016  Alan DeKok <aland@freeradius.org>
+ * @copyright 2016 Alan DeKok <aland@freeradius.org>
  */
 RCSID("$Id$")
 

diff --git a/src/util/time.c b/src/util/time.c
@@ -1,8 +1,4 @@
 /*
- * time.c	Platform independent time functions
- *
- * Version:	$Id$
- *
  *   This program is free software; you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
  *   the Free Software Foundation; either version 2 of the License, or
@@ -16,8 +12,15 @@
  *   You should have received a copy of the GNU General Public License
  *   along with this program; if not, write to the Free Software
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+/**
+ * $Id$
+ *
+ * @brief Platform independent time functions
+ * @file util/time.c
  *
- * Copyright 2016  Alan DeKok <aland@freeradius.org>
+ * @copyright 2016 Alan DeKok <aland@freeradius.org>
  */
 RCSID("$Id$")
 

diff --git a/src/util/track.c b/src/util/track.c
@@ -1,8 +1,4 @@
 /*
- * track.c	RADIUS packet tracking
- *
- * Version:	$Id$
- *
  *   This program is free software; you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
  *   the Free Software Foundation; either version 2 of the License, or
@@ -16,8 +12,15 @@
  *   You should have received a copy of the GNU General Public License
  *   along with this program; if not, write to the Free Software
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+/**
+ * $Id$
+ *
+ * @brief RADIUS packet tracking
+ * @file util/track.c
  *
- * Copyright 2016  Alan DeKok <aland@freeradius.org>
+ * @copyright 2016 Alan DeKok <aland@freeradius.org>
  */
 RCSID("$Id$")
 

diff --git a/src/util/worker.c b/src/util/worker.c
@@ -1,8 +1,4 @@
 /*
- * worker.c	Worker thread functiobns.
- *
- * Version:	$Id$
- *
  *   This program is free software; you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License as published by
  *   the Free Software Foundation; either version 2 of the License, or
@@ -16,8 +12,15 @@
  *   You should have received a copy of the GNU General Public License
  *   along with this program; if not, write to the Free Software
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+ /**
+ * $Id$
+ *
+ * @brief Worker thread functions.
+ * @file util/worker.c
  *
- * Copyright 2016  Alan DeKok <aland@freeradius.org>
+ * @copyright 2016 Alan DeKok <aland@freeradius.org>
  */
 RCSID("$Id$")