Skip to content

Commit

Permalink
Documentation update to work around Latex bug
Browse files Browse the repository at this point in the history
  • Loading branch information
Andy Lucas committed Nov 20, 2014
1 parent 2de7eb1 commit 74efbb5
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 7 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
sw_avb_lc Change Log
====================

6.1.1
-----
* Documentation update to work around Latex bug that prevents compilation of PDF

6.1.0
-----
* Adds example applications for Transport Stream Talker and Listener
Expand Down
4 changes: 2 additions & 2 deletions app_avb_lc_demo/src/avb_conf.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
/** The total number of AVB sources (streams that are to be transmitted). */
#define AVB_NUM_SOURCES 1
/** The total number or Talker components (typically the number of
* tasks running the :c:func:`avb_1722_talker` function). */
* tasks running the avb_1722_talker() function). */
#define AVB_NUM_TALKER_UNITS 1
/** The total number of media inputs (typically number of I2S input channels). */
#define AVB_NUM_MEDIA_INPUTS AVB_DEMO_NUM_CHANNELS
Expand All @@ -59,7 +59,7 @@
/** The total number of AVB sinks (incoming streams that can be listened to) */
#define AVB_NUM_SINKS 1
/** The total number or listener components
* (typically the number of tasks running the :c:func:`avb_1722_listener` function) */
* (typically the number of tasks running the avb_1722_listener() function) */
#define AVB_NUM_LISTENER_UNITS 1
/** The total number of media outputs (typically the number of I2S output channels). */
#define AVB_NUM_MEDIA_OUTPUTS AVB_DEMO_NUM_CHANNELS
Expand Down
4 changes: 2 additions & 2 deletions doc/Makefile
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
DOXYGEN_DIRS=../../sc_avb/module_avb ../../sc_avb/module_avb_media_clock ../../sc_avb/module_gptp ../../sc_avb/module_avb_1722 ../../sc_avb/module_avb_audio ../../sc_avb/module_avb_1722_maap ../../sc_avb/module_avb_srp ../../sc_avb/module_avb_1722_1 ../../sc_avb/module_avb_flash ../app_avb_lc_demo
SOURCE_INCLUDE_DIRS=../../sc_avb/module_avb ../../sc_avb/module_avb_media_clock ../../sc_avb/module_gptp ../../sc_avb/module_avb_1722 ../../sc_avb/module_avb_audio ../../sc_avb/module_avb_1722_maap ../../sc_avb/module_avb_srp ../../sc_avb/module_avb_1722_1 ../../sc_avb/module_avb_flash ../app_avb_lc_demo
DOXYGEN_DIRS=../../sc_avb/module_avb ../../sc_avb/module_avb_media_clock ../../sc_avb/module_gptp ../../sc_avb/module_avb_1722 ../../sc_avb/module_avb_audio ../../sc_avb/module_avb_video ../../sc_avb/module_avb_1722_maap ../../sc_avb/module_avb_srp ../../sc_avb/module_avb_1722_1 ../../sc_avb/module_avb_flash ../app_avb_lc_demo
SOURCE_INCLUDE_DIRS=../../sc_avb/module_avb ../../sc_avb/module_avb_media_clock ../../sc_avb/module_gptp ../../sc_avb/module_avb_1722 ../../sc_avb/module_avb_audio ../../sc_avb/module_avb_video ../../sc_avb/module_avb_1722_maap ../../sc_avb/module_avb_srp ../../sc_avb/module_avb_1722_1 ../../sc_avb/module_avb_flash ../app_avb_lc_demo
12 changes: 9 additions & 3 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,7 @@ Component tasks and functions
-----------------------------

The following functions provide components that can be combined in the
top-level main. For details on the Ethernet component, see
the `Ethernet Component Guide
<http://github.xcore.com/sc_ethernet/index.html>`_.
top-level main.

Core components
~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -148,6 +146,14 @@ The following functions implement AVB audio components:

.. doxygenfunction:: media_output_fifo_to_xc_channel_split_lr

Video components
~~~~~~~~~~~~~~~~

The following functions implement AVB video components:

.. doxygenfunction:: tsi_output

.. doxygenfunction:: tsi_input

.. _sec_avb_api:

Expand Down

0 comments on commit 74efbb5

Please sign in to comment.