From bb55955a62520217c4566d6cc7e2e17b545b93f6 Mon Sep 17 00:00:00 2001 From: dankers Date: Sun, 29 Nov 2009 10:29:35 +0000 Subject: [PATCH] Bit more doxygen, basically just tests. The file headers are complete on all files (took way longer than I would have liked). No functions have been touched apart from two in pios_uart.c that I am committing now. I'm committing that so I don't clash with work you have done. Working on auto generating the doc every night now on the server. git-svn-id: svn://svn.openpilot.org/OpenPilot/trunk@18 ebee16cc-31ac-478f-84a7-5cbb03baadba --- flight/sys/pios_uart.c | 35 ++++++++++++++--------------------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/flight/sys/pios_uart.c b/flight/sys/pios_uart.c index c83ab3e3a..cb8d636a3 100644 --- a/flight/sys/pios_uart.c +++ b/flight/sys/pios_uart.c @@ -45,11 +45,9 @@ static volatile u8 tx_buffer_size[UART_NUM]; /** -* Function Name : UARTInit -* Description : Initialise the GPS and TELEM onboard UARTs -* Input : None -* Output : None -* Return : None +* +* Initialise the GPS and TELEM onboard UARTs +* */ void UARTInit(void) { @@ -142,11 +140,9 @@ void UARTInit(void) /** -* Function Name : EnableAuxUART -* Description : Enables AUX UART at the expense of servo inputs -* Input : None -* Output : None -* Return : None +* +* Enables AUX UART at the expense of servo inputs +* */ void EnableAuxUART(void) { @@ -155,11 +151,9 @@ void EnableAuxUART(void) /** -* Function Name : DisableAuxUART -* Description : Disables AUX UART reclaims two servo inputs -* Input : None -* Output : None -* Return : None +* +* Disables AUX UART reclaims two servo inputs +* */ void DisableAuxUART(void) { @@ -168,12 +162,11 @@ void DisableAuxUART(void) /** -* Function Name : UARTInit -* Description : Changes the baud rate of the USART peripherial without -* : re-initialising. -* Input : USART to change, new baud rate -* Output : None -* Return : None +* +* Changes the baud rate of the USART peripherial without re-initialising. +* @param[in] UART Number +* @param[in] Required baud rate +* */ void UARTChangeBaud(USART_TypeDef* USARTx, uint32_t Baud) {