michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: fix references to examples in variables.rst

Browse source 
Files had been changed without the offsets being updated, so it was
generating warnings.

Change-Id: I5c7756f396cf607470da1ce6c5807e5a343491d2
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
This commit is contained in:
Inaky Perez-Gonzalez 2016-06-13 15:30:27 -07:00 • committed by Anas Nashif
commit e03babf7d0
1 changed files with 4 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

9
doc/contribute/doxygen/variables.rst
View file

@ -29,7 +29,7 @@ the best practices.
.. literalinclude:: phil_fiber_commented.c
:language: c
:lines: 110-168
:lines: 92-160
:emphasize-lines: 15, 18, 21-23, 25, 31
:linenos:
@ -53,9 +53,8 @@ Example 2
=========
Variables outside of functions must be documented as well.
.. literalinclude:: hello_commented.c
:language: c
:lines: 133-140
.. literalinclude:: ./hello_commented.c
:lines: 119-127
:emphasize-lines: 1, 4, 7
:linenos:
@ -68,4 +67,4 @@ Notice that the variable comments also apply for more complex types like
structs. The comments on lines 4 and 7 apply only to the specific
variable and not to the whole struct. Complex types must be documented
wherever they are defined. See :ref:`structs` and
:ref:`typedefs` for further details.
:ref:`typedefs` for further details.