Module: xenomai-3
Branch: master
Commit: 89d1c61efb0519b440142c55cab69b0a1077b083
URL:
http://git.xenomai.org/?p=xenomai-3.git;a=commit;h=89d1c61efb0519b440142c55cab69b0a1077b083
Author: Philippe Gerum <r...@xenomai.org>
Date: Thu Feb 12 12:10:52 2015 +0100
doc: assorted doxygen fixups
---
doc/doxygen/xeno3prm-common.conf.in | 12 ------------
include/alchemy/sem.h | 2 +-
kernel/drivers/net/drivers/e1000e/phy.c | 21 +++++++++++----------
kernel/drivers/net/drivers/rt_macb.h | 14 ++++++++------
kernel/drivers/net/stack/rtnet_chrdev.c | 7 -------
5 files changed, 20 insertions(+), 36 deletions(-)
diff --git a/doc/doxygen/xeno3prm-common.conf.in
b/doc/doxygen/xeno3prm-common.conf.in
index 88d6771..bb54a7a 100644
--- a/doc/doxygen/xeno3prm-common.conf.in
+++ b/doc/doxygen/xeno3prm-common.conf.in
@@ -560,18 +560,6 @@ GENERATE_XML = NO
XML_OUTPUT = xml
-# The XML_SCHEMA tag can be used to specify an XML schema,
-# which can be used by a validating XML parser to check the
-# syntax of the XML files.
-
-XML_SCHEMA =
-
-# The XML_DTD tag can be used to specify an XML DTD,
-# which can be used by a validating XML parser to check the
-# syntax of the XML files.
-
-XML_DTD =
-
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
diff --git a/include/alchemy/sem.h b/include/alchemy/sem.h
index 9181e95..8f86824 100644
--- a/include/alchemy/sem.h
+++ b/include/alchemy/sem.h
@@ -39,7 +39,7 @@ typedef struct RT_SEM RT_SEM;
/**
* @brief Semaphore status descriptor
- * @anchor RT_QUEUE_INFO
+ * @anchor RT_SEM_INFO
*
* This structure reports various static and runtime information about
* a semaphore, returned by a call to rt_sem_inquire().
diff --git a/kernel/drivers/net/drivers/e1000e/phy.c
b/kernel/drivers/net/drivers/e1000e/phy.c
index 21f9182..66ae389 100644
--- a/kernel/drivers/net/drivers/e1000e/phy.c
+++ b/kernel/drivers/net/drivers/e1000e/phy.c
@@ -348,14 +348,14 @@ s32 e1000e_write_phy_reg_m88(struct e1000_hw *hw, u32
offset, u16 data)
}
/**
- * e1000_set_page_igp - Set page as on IGP-like PHY(s)
- * @hw: pointer to the HW structure
- * @page: page to set (shifted left when necessary)
+ * @brief Set page as on IGP-like PHY(s)
+ * @param hw pointer to the HW structure
+ * @param page page to set (shifted left when necessary)
*
* Sets PHY page required for PHY register access. Assumes semaphore is
* already acquired. Note, this function sets phy.addr to 1 so the caller
* must set it appropriately (if necessary) after this function returns.
- **/
+ */
s32 e1000_set_page_igp(struct e1000_hw *hw, u16 page)
{
e_dbg("Setting page 0x%x\n", page);
@@ -2405,10 +2405,10 @@ out:
}
/**
- * e1000_get_phy_addr_for_bm_page - Retrieve PHY page address
- * @page: page to access
+ * @brief Retrieve PHY page address
+ * @param page page to access
*
- * Returns the phy address for the page requested.
+ * @return PHY address for the page requested.
**/
static u32 e1000_get_phy_addr_for_bm_page(u32 page, u32 reg)
{
@@ -3096,9 +3096,10 @@ s32 e1000_write_phy_reg_page_hv(struct e1000_hw *hw, u32
offset, u16 data)
}
/**
- * e1000_get_phy_addr_for_hv_page - Get PHY address based on page
- * @page: page to be accessed
- **/
+ * @brief Get PHY address based on page
+ * @param page page to be accessed
+ * @return PHY address
+ */
static u32 e1000_get_phy_addr_for_hv_page(u32 page)
{
u32 phy_addr = 2;
diff --git a/kernel/drivers/net/drivers/rt_macb.h
b/kernel/drivers/net/drivers/rt_macb.h
index bc69939..53b9607 100644
--- a/kernel/drivers/net/drivers/rt_macb.h
+++ b/kernel/drivers/net/drivers/rt_macb.h
@@ -390,12 +390,13 @@
})
/**
- * struct macb_dma_desc - Hardware DMA descriptor
- * @addr: DMA address of data buffer
- * @ctrl: Control and status bits
+ * @brief Hardware DMA descriptor
+ * @anchor macb_dma_desc
*/
struct macb_dma_desc {
+ /** DMA address of data buffer */
u32 addr;
+ /** Control and status bits */
u32 ctrl;
};
@@ -460,12 +461,13 @@ struct macb_dma_desc {
#define MACB_TX_USED_SIZE 1
/**
- * struct macb_tx_skb - data about an skb which is being transmitted
- * @skb: skb currently being transmitted
- * @mapping: DMA address of the skb's data buffer
+ * @brief Data about an skb which is being transmitted
+ * @anchor macb_tx_skb
*/
struct macb_tx_skb {
+ /** skb currently being transmitted */
struct rtskb *skb;
+ /** DMA address of the skb's data buffer */
dma_addr_t mapping;
};
diff --git a/kernel/drivers/net/stack/rtnet_chrdev.c
b/kernel/drivers/net/stack/rtnet_chrdev.c
index 593a3e2..a64d6da 100644
--- a/kernel/drivers/net/stack/rtnet_chrdev.c
+++ b/kernel/drivers/net/stack/rtnet_chrdev.c
@@ -39,13 +39,6 @@
static DEFINE_SPINLOCK(ioctl_handler_lock);
static LIST_HEAD(ioctl_handlers);
-/**
- * rtnet_ioctl -
- * @inode:
- * @file:
- * @request:
- * @arg:
- */
static long rtnet_ioctl(struct file *file,
unsigned int request, unsigned long arg)
{
_______________________________________________
Xenomai-git mailing list
Xenomai-git@xenomai.org
http://www.xenomai.org/mailman/listinfo/xenomai-git
