Common Update: Better Doxygen Style

df_datalink_sp/src/util/circ_queue.c

@@ -1,34 +1,25 @@
 /*****************************************************************************/
 /**
- * Description: A simple circular FIFO bounded queue
+ * @file circ_queue.c
+ * @author FanHao ([email protected])
+ * @brief A simple circular FIFO bounded queue
+ * @version 0.1
+ * @date 2023-02-23
+ * @note Forked from https://github.com/chrismerck/rpa_queue.git
+ * @copyright Copyright(c) 2024 Beijing Institute of Technology.\n
+ * Lab of Communication and Network
  *
- * Author: Fan Hao
- * Date: 2023-02-23 10:29
- * LastEditors: Fan Hao
- * LastEditTime: 2023-02-23 13:18
- * Revisions: Rev 0.0
- * History:
- * [2023-02-23]: Initial Version.
- *
- * Copyright(c) 2023 Beijing Institute of Technology.
- * Lab of Communication and Networking
- * NOTE: Forked from https://github.com/chrismerck/rpa_queue.git
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements.  See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
  ******************************************************************************/
 
+/**
+ * @addtogroup Utility
+ * @{
+ */
+
+/**
+ * @addtogroup CircularQueue
+ * @{
+ */
 #include "circ_queue.h"
 #include "common.h"
 #include <stdio.h>
@@ -56,7 +47,7 @@ void CircQueueFree(CIRC_QUEUE *queue)
 }
 
 /**
- * Initialize the CIRC_QUEUE.
+ * @brief Initialize the CIRC_QUEUE.
  */
 bool CircQueueCreate(CIRC_QUEUE **q, uint32_t queueCapacity)
 {
@@ -87,7 +78,7 @@ error:
 }
 
 /**
- * Push new data onto the queue.
+ * @brief Push new data onto the queue.
  */
 bool CircQueuePush(CIRC_QUEUE *queue, void *data)
 {
@@ -110,7 +101,7 @@ bool CircQueuePush(CIRC_QUEUE *queue, void *data)
 }
 
 /**
- * Return current number of element in queue.
+ * @brief Return current number of element in queue.
  */
 inline uint32_t CircQueueSize(CIRC_QUEUE *queue)
 {
@@ -118,7 +109,7 @@ inline uint32_t CircQueueSize(CIRC_QUEUE *queue)
 }
 
 /**
- * Retrieves the next item from the queue.
+ * @brief Retrieves the next item from the queue.
  */
 bool CircQueuePop(CIRC_QUEUE *queue, void **data)
 {
@@ -139,3 +130,5 @@ bool CircQueuePop(CIRC_QUEUE *queue, void **data)
   }
   return true;
 }
+/** @} CircularQueue*/
+/** @} Utility*/