Fix a number of top level doxygen issues.
So that the navigation pane works correctly in browsers. Some additional doc fixes put in where found (but many more still to go). Added some dummy .c and .h files to bring the associated docs into line. makefile changed to allow 'make html' as well as 'make doc' (the latter only does html anyway).
This commit is contained in:
committed by
Frantisek Burian
parent
a54a12e1c9
commit
3c6e9fd56d
@@ -20,6 +20,8 @@
|
||||
* This provides the code for the "next gen" EXTI block provided in F2/F4/L1
|
||||
* devices. (differences only in the source selection)
|
||||
*/
|
||||
/**@{*/
|
||||
|
||||
|
||||
#include <libopencm3/stm32/memorymap.h>
|
||||
#include <libopencm3/stm32/exti.h>
|
||||
@@ -149,3 +151,5 @@ void exti_select_source(uint32_t exti, uint32_t gpioport)
|
||||
#endif
|
||||
};
|
||||
}
|
||||
/**@}*/
|
||||
|
||||
|
||||
@@ -21,6 +21,7 @@
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
/**@{*/
|
||||
|
||||
/**@{*/
|
||||
|
||||
|
||||
@@ -21,6 +21,7 @@
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
/**@{*/
|
||||
|
||||
/**@{*/
|
||||
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
/** @addtogroup hash_file
|
||||
|
||||
@author @htmlonly © @endhtmlonly 2013
|
||||
Mikhail Avkhimenia <mikhail@avkhimenia.net>
|
||||
|
||||
This library supports the HASH processor in the STM32F2 and STM32F4
|
||||
series of ARM Cortex Microcontrollers by ST Microelectronics.
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
*
|
||||
* @author @htmlonly © @endhtmlonly 2013
|
||||
* Mikhail Avkhimenia <mikhail@avkhimenia.net>
|
||||
*
|
||||
* This library supports the HASH processor in the STM32F2 and STM32F4
|
||||
* series of ARM Cortex Microcontrollers by ST Microelectronics.
|
||||
*
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
* */
|
||||
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
@@ -159,3 +159,5 @@ void hash_get_result(uint32_t *data)
|
||||
data[4] = HASH_HR[4];
|
||||
}
|
||||
}
|
||||
/**@}*/
|
||||
|
||||
|
||||
@@ -17,6 +17,7 @@
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
/**@{*/
|
||||
|
||||
#include <libopencm3/stm32/rcc.h>
|
||||
|
||||
@@ -181,6 +182,7 @@ void rcc_periph_reset_release(enum rcc_periph_rst rst)
|
||||
{
|
||||
_RCC_REG(rst) &= ~_RCC_BIT(rst);
|
||||
}
|
||||
/**@}*/
|
||||
|
||||
#undef _RCC_REG
|
||||
#undef _RCC_BIT
|
||||
|
||||
@@ -27,6 +27,7 @@
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
/**@{*/
|
||||
|
||||
#include <libopencm3/stm32/comparator.h>
|
||||
|
||||
@@ -59,3 +60,5 @@ void comp_select_speed(uint8_t id, uint32_t speed)
|
||||
{
|
||||
COMP_CSR(id) = (COMP_CSR(id) & ~COMP_CSR_SPEED) | speed;
|
||||
}
|
||||
/**@}*/
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/** @defgroup pwr-file PWR
|
||||
/** @defgroup pwr_file PWR
|
||||
*
|
||||
* @ingroup STM32F0xx
|
||||
*
|
||||
|
||||
@@ -1,21 +1,21 @@
|
||||
/** @defgroup pwr-file PWR
|
||||
|
||||
@ingroup STM32F1xx
|
||||
|
||||
@brief <b>libopencm3 STM32F1xx Power Control</b>
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@author @htmlonly © @endhtmlonly 2012
|
||||
Ken Sarkies <ksarkies@internode.on.net>
|
||||
|
||||
@date 18 August 2012
|
||||
|
||||
This library supports the power control system for the
|
||||
STM32F1 series of ARM Cortex Microcontrollers by ST Microelectronics.
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
/** @defgroup pwr_file PWR
|
||||
*
|
||||
* @ingroup STM32F1xx
|
||||
*
|
||||
* @brief <b>libopencm3 STM32F1xx Power Control</b>
|
||||
*
|
||||
* @version 1.0.0
|
||||
*
|
||||
* @author @htmlonly © @endhtmlonly 2012
|
||||
* Ken Sarkies <ksarkies@internode.on.net>
|
||||
*
|
||||
* @date 18 August 2012
|
||||
*
|
||||
* This library supports the power control system for the
|
||||
* STM32F1 series of ARM Cortex Microcontrollers by ST Microelectronics.
|
||||
*
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
*
|
||||
|
||||
@@ -1,18 +1,18 @@
|
||||
/** @defgroup rtc_file RTC
|
||||
|
||||
@ingroup STM32F1xx
|
||||
|
||||
@brief <b>libopencm3 STM32F1xx RTC</b>
|
||||
|
||||
@author @htmlonly © @endhtmlonly 2010 Uwe Hermann <uwe@hermann-uwe.de>
|
||||
@author @htmlonly © @endhtmlonly 2010 Lord James <lordjames@y7mail.com>
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 4 March 2013
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
*
|
||||
* @ingroup STM32F1xx
|
||||
*
|
||||
* @brief <b>libopencm3 STM32F1xx RTC</b>
|
||||
*
|
||||
* @author @htmlonly © @endhtmlonly 2010 Uwe Hermann <uwe@hermann-uwe.de>
|
||||
* @author @htmlonly © @endhtmlonly 2010 Lord James <lordjames@y7mail.com>
|
||||
*
|
||||
* @version 1.0.0
|
||||
*
|
||||
* @date 4 March 2013
|
||||
*
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
@@ -33,6 +33,8 @@ LGPL License Terms @ref lgpl_license
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
/**@{*/
|
||||
|
||||
|
||||
#include <libopencm3/stm32/rcc.h>
|
||||
#include <libopencm3/stm32/rtc.h>
|
||||
@@ -299,3 +301,5 @@ void rtc_auto_awake(enum rcc_osc clock_source, uint32_t prescale_val)
|
||||
rtc_set_prescale_val(prescale_val);
|
||||
}
|
||||
}
|
||||
/**@}*/
|
||||
|
||||
|
||||
33
lib/stm32/f2/crypto.c
Normal file
33
lib/stm32/f2/crypto.c
Normal file
@@ -0,0 +1,33 @@
|
||||
/** @defgroup crypto_file CRYPTO
|
||||
*
|
||||
* @ingroup STM32F2xx
|
||||
*
|
||||
* @brief <b>libopencm3 STM32F2xx Cryptographic controller</b>
|
||||
*
|
||||
* @version 1.0.0
|
||||
*
|
||||
* @date 14 January 2014
|
||||
*
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
*
|
||||
* This library is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <libopencm3/stm32/crypto.h>
|
||||
#include <libopencm3/stm32/common/crypto_common_all.h>
|
||||
|
||||
33
lib/stm32/f2/hash.c
Normal file
33
lib/stm32/f2/hash.c
Normal file
@@ -0,0 +1,33 @@
|
||||
/** @defgroup hash_file HASH
|
||||
*
|
||||
* @ingroup STM32F2xx
|
||||
*
|
||||
* @brief <b>libopencm3 STM32F2xx Hash Processor</b>
|
||||
*
|
||||
* @version 1.0.0
|
||||
*
|
||||
* @date 14 January 2014
|
||||
*
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
*
|
||||
* This library is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <libopencm3/stm32/hash.h>
|
||||
#include <libopencm3/stm32/common/hash_common_f24.h>
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
/** @defgroup i2c_file I2C
|
||||
|
||||
@ingroup STM32F2xx
|
||||
|
||||
@brief <b>libopencm3 STM32F2xx I2C</b>
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@date 15 October 2012
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
*
|
||||
* @ingroup STM32F2xx
|
||||
*
|
||||
* @brief <b>libopencm3 STM32F2xx I2C</b>
|
||||
*
|
||||
* @version 1.0.0
|
||||
*
|
||||
* @date 15 October 2012
|
||||
*
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
@@ -29,5 +29,5 @@ LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
#include <libopencm3/stm32/i2c.h>
|
||||
#include <libopencm3/stm32/common/spi_common_all.h>
|
||||
#include <libopencm3/stm32/common/i2c_common_all.h>
|
||||
|
||||
|
||||
39
lib/stm32/f2/pwr.c
Normal file
39
lib/stm32/f2/pwr.c
Normal file
@@ -0,0 +1,39 @@
|
||||
/** @defgroup pwr_file PWR
|
||||
*
|
||||
* @ingroup STM32F2xx
|
||||
*
|
||||
* @brief <b>libopencm3 STM32F2xx Power Control</b>
|
||||
*
|
||||
* @version 1.0.0
|
||||
*
|
||||
* @author @htmlonly © @endhtmlonly 2014
|
||||
* Ken Sarkies <ksarkies@internode.on.net>
|
||||
*
|
||||
* @date 13 January 2014
|
||||
*
|
||||
* This library supports the power control system for the
|
||||
* STM32F4 series of ARM Cortex Microcontrollers by ST Microelectronics.
|
||||
*
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
*
|
||||
* Copyright (C) 2014 Ken Sarkies <ksarkies@internode.on.net>
|
||||
*
|
||||
* This library is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <libopencm3/stm32/pwr.h>
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
*
|
||||
* @section rcc_f2_api_ex Reset and Clock Control API.
|
||||
*
|
||||
* @brief <b>libopencm3 STM32F4xx Reset and Clock Control</b>
|
||||
* @brief <b>libopencm3 STM32F2xx Reset and Clock Control</b>
|
||||
*
|
||||
* @author @htmlonly © @endhtmlonly 2013 Frantisek Burian <BuFran at seznam.cz>
|
||||
*
|
||||
|
||||
@@ -41,6 +41,7 @@
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
/**@{*/
|
||||
|
||||
/**@{*/
|
||||
|
||||
|
||||
@@ -2,7 +2,12 @@
|
||||
*
|
||||
* @ingroup STM32F3xx
|
||||
*
|
||||
* @brief <b>libopencm3 STM32F3xx Power control</b>
|
||||
* @brief <b>libopencm3 STM32F3xx Power Control</b>
|
||||
*
|
||||
* @author @htmlonly © @endhtmlonly 2014
|
||||
* Ken Sarkies <ksarkies@internode.on.net>
|
||||
*
|
||||
* @date 13 January 2014
|
||||
*
|
||||
* @version 1.0.0
|
||||
*
|
||||
@@ -14,6 +19,8 @@
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
*
|
||||
* Copyright (C) 2014 Ken Sarkies <ksarkies@internode.on.net>
|
||||
*
|
||||
* This library is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
|
||||
@@ -32,6 +32,7 @@
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
/**@{*/
|
||||
|
||||
#include <libopencm3/cm3/assert.h>
|
||||
#include <libopencm3/stm32/f3/rcc.h>
|
||||
@@ -460,3 +461,5 @@ void rcc_usb_prescale_1(void)
|
||||
{
|
||||
RCC_CFGR |= RCC_CFGR_USBPRES;
|
||||
}
|
||||
/**@}*/
|
||||
|
||||
|
||||
38
lib/stm32/f3/rtc.c
Normal file
38
lib/stm32/f3/rtc.c
Normal file
@@ -0,0 +1,38 @@
|
||||
/** @defgroup rtc_file RTC
|
||||
*
|
||||
* @ingroup STM32F3xx
|
||||
*
|
||||
* @brief <b>libopencm3 STM32F3xx Real Time Clock</b>
|
||||
*
|
||||
* @version 1.0.0
|
||||
*
|
||||
* @author @htmlonly © @endhtmlonly 2014
|
||||
* Ken Sarkies <ksarkies@internode.on.net>
|
||||
*
|
||||
* @date 13 January 2014
|
||||
*
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
*
|
||||
* Copyright (C) 2014 Ken Sarkies <ksarkies@internode.on.net>
|
||||
*
|
||||
* This library is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <libopencm3/stm32/rtc.h>
|
||||
|
||||
|
||||
33
lib/stm32/f4/hash.c
Normal file
33
lib/stm32/f4/hash.c
Normal file
@@ -0,0 +1,33 @@
|
||||
/** @defgroup hash_file HASH
|
||||
*
|
||||
* @ingroup STM32F4xx
|
||||
*
|
||||
* @brief <b>libopencm3 STM32F4xx Hash Processor</b>
|
||||
*
|
||||
* @version 1.0.0
|
||||
*
|
||||
* @date 13 January 2014
|
||||
*
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
*
|
||||
* This library is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This library is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with this library. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <libopencm3/stm32/hash.h>
|
||||
#include <libopencm3/stm32/common/hash_common_f24.h>
|
||||
|
||||
@@ -1,20 +1,20 @@
|
||||
/** @defgroup pwr-file PWR
|
||||
|
||||
@ingroup STM32F4xx
|
||||
|
||||
@brief <b>libopencm3 STM32F4xx Power Control</b>
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@author @htmlonly © @endhtmlonly 2011 Stephen Caudle <scaudle@doceme.com>
|
||||
|
||||
@date 4 March 2013
|
||||
|
||||
This library supports the power control system for the
|
||||
STM32F4 series of ARM Cortex Microcontrollers by ST Microelectronics.
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
/** @defgroup pwr_file PWR
|
||||
*
|
||||
* @ingroup STM32F4xx
|
||||
*
|
||||
* @brief <b>libopencm3 STM32F4xx Power Control</b>
|
||||
*
|
||||
* @version 1.0.0
|
||||
*
|
||||
* @author @htmlonly © @endhtmlonly 2011 Stephen Caudle <scaudle@doceme.com>
|
||||
*
|
||||
* @date 4 March 2013
|
||||
*
|
||||
* This library supports the power control system for the
|
||||
* STM32F4 series of ARM Cortex Microcontrollers by ST Microelectronics.
|
||||
*
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
*
|
||||
|
||||
@@ -1,20 +1,20 @@
|
||||
/** @defgroup pwr-file PWR
|
||||
|
||||
@ingroup STM32L1xx
|
||||
|
||||
@brief <b>libopencm3 STM32L1xx Power Control</b>
|
||||
|
||||
@version 1.0.0
|
||||
|
||||
@author @htmlonly © @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
|
||||
|
||||
@date 4 March 2013
|
||||
|
||||
This library supports the power control system for the
|
||||
STM32L1 series of ARM Cortex Microcontrollers by ST Microelectronics.
|
||||
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
/** @defgroup pwr_file PWR
|
||||
*
|
||||
* @ingroup STM32L1xx
|
||||
*
|
||||
* @brief <b>libopencm3 STM32L1xx Power Control</b>
|
||||
*
|
||||
* @version 1.0.0
|
||||
*
|
||||
* @author @htmlonly © @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
|
||||
*
|
||||
* @date 4 March 2013
|
||||
*
|
||||
* This library supports the power control system for the
|
||||
* STM32L1 series of ARM Cortex Microcontrollers by ST Microelectronics.
|
||||
*
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
/*
|
||||
* This file is part of the libopencm3 project.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user