diff options
| author | bnewbold <bnewbold@robocracy.org> | 2014-08-28 16:39:14 -0400 |
|---|---|---|
| committer | bnewbold <bnewbold@robocracy.org> | 2014-08-28 16:39:20 -0400 |
| commit | fc4552f351a01f395e9d1b10b0ada8619ba09d5d (patch) | |
| tree | 5dd9870da1fb36cefbd7210512a064abf9dbd9ce /docs | |
| parent | 3a24a1139bb699234cd66f7aaef6572edf70974d (diff) | |
| download | librambutan-fc4552f351a01f395e9d1b10b0ada8619ba09d5d.tar.gz librambutan-fc4552f351a01f395e9d1b10b0ada8619ba09d5d.zip | |
docs: stm32f1/2 namespacing for more variables
There is still a TODO to rework/refactor the entire pages to look
prettier, but this keeps breathe from complaining about missing
variables (and potentially crashing Sphinx, depending on breathe patch
level)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/libmaple/api/dac.rst | 5 | ||||
| -rw-r--r-- | docs/source/libmaple/api/dma.rst | 5 | ||||
| -rw-r--r-- | docs/source/libmaple/api/gpio.rst | 15 | ||||
| -rw-r--r-- | docs/source/libmaple/api/timer.rst | 5 |
4 files changed, 21 insertions, 9 deletions
diff --git a/docs/source/libmaple/api/dac.rst b/docs/source/libmaple/api/dac.rst index 4e9eb56..47955ef 100644 --- a/docs/source/libmaple/api/dac.rst +++ b/docs/source/libmaple/api/dac.rst @@ -12,8 +12,11 @@ Digital to Analog Conversion (DAC) support. Types ----- +.. TODO: refactor correctly for stm32f1/stm32f2 distinction + .. doxygenstruct:: dac_dev -.. doxygenstruct:: dac_reg_map +.. doxygenstruct:: stm32f1::dac_reg_map +.. doxygenstruct:: stm32f2::dac_reg_map Devices ------- diff --git a/docs/source/libmaple/api/dma.rst b/docs/source/libmaple/api/dma.rst index b5ffad6..286b6d6 100644 --- a/docs/source/libmaple/api/dma.rst +++ b/docs/source/libmaple/api/dma.rst @@ -12,7 +12,10 @@ Direct Memory Access (DMA) support. Types ----- -.. doxygenstruct:: dma_reg_map +.. TODO: seperate stm32f1/stm32f2 families correctly + +.. doxygenstruct:: stm32f1::dma_reg_map +.. doxygenstruct:: stm32f2::dma_reg_map .. doxygenstruct:: dma_dev .. doxygenstruct:: dma_handler_config .. doxygenenum:: dma_mode_flags diff --git a/docs/source/libmaple/api/gpio.rst b/docs/source/libmaple/api/gpio.rst index faf0ad2..9e8e5c7 100644 --- a/docs/source/libmaple/api/gpio.rst +++ b/docs/source/libmaple/api/gpio.rst @@ -13,15 +13,18 @@ Input/Output (AFIO) support. Types ----- -.. doxygenstruct:: gpio_reg_map +.. TODO: seperate stm32f1/stm32f2 families correctly + +.. doxygenstruct:: stm32f1::gpio_reg_map +.. doxygenstruct:: stm32f2::gpio_reg_map .. doxygenstruct:: gpio_dev .. doxygenenum:: gpio_pin_mode -.. doxygenstruct:: afio_reg_map -.. doxygenenum:: afio_exti_port -.. doxygenenum:: afio_exti_num -.. doxygenenum:: afio_remap_peripheral -.. doxygenenum:: afio_debug_cfg +.. doxygenstruct:: stm32f1::afio_reg_map +.. doxygentypedef:: stm32f1::afio_exti_port +.. doxygentypedef:: stm32f1::afio_exti_num +.. doxygentypedef:: stm32f1::afio_remap_peripheral +.. doxygentypedef:: stm32f1::afio_debug_cfg Devices ------- diff --git a/docs/source/libmaple/api/timer.rst b/docs/source/libmaple/api/timer.rst index f315cb0..0b261fc 100644 --- a/docs/source/libmaple/api/timer.rst +++ b/docs/source/libmaple/api/timer.rst @@ -18,8 +18,11 @@ that there are advanced, general purpose, and basic timers. Thus, each kind of timer has a register map type, and a ``union timer_reg_map`` ties it all together. +.. TODO: seperate stm32f1/stm32f2 families correctly + .. doxygenstruct:: timer_adv_reg_map -.. doxygenstruct:: timer_gen_reg_map +.. doxygenstruct:: stm32f1::timer_gen_reg_map +.. doxygenstruct:: stm32f2::timer_gen_reg_map .. doxygenstruct:: timer_bas_reg_map .. doxygenunion:: timer_reg_map .. doxygenenum:: timer_type |