diff options
author | bnewbold <bnewbold@robocracy.org> | 2015-05-27 23:15:55 -0700 |
---|---|---|
committer | bnewbold <bnewbold@robocracy.org> | 2015-05-27 23:15:55 -0700 |
commit | 124c8964eb81705d0924295e63866370e9c16ede (patch) | |
tree | 16ac60db3e07d2a90d60730b3c4fc5bd218108a2 /docs/source/libmaple | |
parent | 6f45284326411f3f3d68e077449f14a2d1caa693 (diff) | |
download | librambutan-124c8964eb81705d0924295e63866370e9c16ede.tar.gz librambutan-124c8964eb81705d0924295e63866370e9c16ede.zip |
docs: many small broken ref fixes, syntax bugfixes
Diffstat (limited to 'docs/source/libmaple')
-rw-r--r-- | docs/source/libmaple/api/dma.rst | 10 | ||||
-rw-r--r-- | docs/source/libmaple/api/gpio.rst | 7 | ||||
-rw-r--r-- | docs/source/libmaple/api/nvic.rst | 2 | ||||
-rw-r--r-- | docs/source/libmaple/api/util.rst | 2 | ||||
-rw-r--r-- | docs/source/libmaple/overview.rst | 2 |
5 files changed, 15 insertions, 8 deletions
diff --git a/docs/source/libmaple/api/dma.rst b/docs/source/libmaple/api/dma.rst index 286b6d6..4ce298d 100644 --- a/docs/source/libmaple/api/dma.rst +++ b/docs/source/libmaple/api/dma.rst @@ -34,6 +34,10 @@ Devices Functions --------- +.. NB: Some of these functions have multiple definitions, in which case the + complete function signature needs to be specified to disambiguate or breathe + will choke ("Unable to resolve multiple matches for function"...) + .. doxygenfunction:: dma_init .. doxygenfunction:: dma_setup_transfer .. doxygenfunction:: dma_set_num_transfers @@ -43,12 +47,12 @@ Functions .. doxygenfunction:: dma_get_irq_cause .. doxygenfunction:: dma_enable .. doxygenfunction:: dma_disable -.. doxygenfunction:: dma_set_mem_addr +.. doxygenfunction:: dma_set_mem_addr(dma_dev *, dma_tube, __io void *) .. doxygenfunction:: dma_set_per_addr .. doxygendefine:: dma_channel_regs .. doxygendefine:: dma_is_channel_enabled -.. doxygenfunction:: dma_get_isr_bits -.. doxygenfunction:: dma_clear_isr_bits +.. doxygenfunction:: dma_get_isr_bits(dma_dev *, dma_tube) +.. doxygenfunction:: dma_clear_isr_bits(dma_dev *, dma_tube) Register Map Base Pointers -------------------------- diff --git a/docs/source/libmaple/api/gpio.rst b/docs/source/libmaple/api/gpio.rst index 9e8e5c7..5f631d5 100644 --- a/docs/source/libmaple/api/gpio.rst +++ b/docs/source/libmaple/api/gpio.rst @@ -42,14 +42,17 @@ Functions .. doxygenfunction:: gpio_init .. doxygenfunction:: gpio_init_all -.. doxygenfunction:: gpio_set_mode +.. doxygenfunction:: gpio_set_mode(gpio_dev *, uint8, gpio_pin_mode) .. doxygenfunction:: gpio_exti_port .. doxygenfunction:: gpio_write_bit .. doxygenfunction:: gpio_read_bit .. doxygenfunction:: gpio_toggle_bit .. doxygenfunction:: afio_init -.. doxygenfunction:: afio_exti_select + +.. c:macro:: afio_exti_select(exti, port) + + Macro for `exti_select((exti), (port))`. .. _gpio-h-afio-remap: .. doxygenfunction:: afio_remap diff --git a/docs/source/libmaple/api/nvic.rst b/docs/source/libmaple/api/nvic.rst index 505e36e..815da2b 100644 --- a/docs/source/libmaple/api/nvic.rst +++ b/docs/source/libmaple/api/nvic.rst @@ -49,7 +49,7 @@ Functions .. doxygenfunction:: nvic_globalirq_disable .. doxygenfunction:: nvic_irq_enable .. doxygenfunction:: nvic_irq_disable -.. doxygenfunction:: nvic_irq_disable_all +.. doxygenfunction:: nvic_irq_disable_all(void) .. doxygenfunction:: nvic_sys_reset Register Maps diff --git a/docs/source/libmaple/api/util.rst b/docs/source/libmaple/api/util.rst index 54377c0..2f6e080 100644 --- a/docs/source/libmaple/api/util.rst +++ b/docs/source/libmaple/api/util.rst @@ -50,5 +50,5 @@ If an assertion fails, execution is halted at the point of the failed assertion. When libmaple has been configured properly (Wirish performs this configuration by default), the built-in LED throbs in a smooth pattern to signal the failed assertion (using -:c:func:`throb()`), and the file and line where the assert failed are +``throb()``), and the file and line where the assert failed are transmitted to the user as detailed in :ref:`lang-assert`. diff --git a/docs/source/libmaple/overview.rst b/docs/source/libmaple/overview.rst index 006f1d8..4f0db1b 100644 --- a/docs/source/libmaple/overview.rst +++ b/docs/source/libmaple/overview.rst @@ -467,7 +467,7 @@ do a read-modify-write sequence on the DMA_CCR_PL bits like so:: Of course, before doing that, you should check to make sure there's not already a device-level function for performing the same task! (In -this case, there is. It's called :c:func:`dma_set_priority()`; see +this case, there is. It's called ``dma_set_priority()``; see :ref:`libmaple-dma`.) For instance, **none of the above code is portable** to STM32F4, which uses DMA streams instead of channels for this purpose. |