Lines Matching +full:c +full:- +full:version +full:- +full:name

5 Sometimes, it is useful to include header files and C example codes in
6 order to describe the userspace API and to generate cross-references
7 between the code and the documentation. Adding cross-references for
12 cross-references. It has to be called via Makefile, while building the
13 documentation. Please see ``Documentation/userspace-api/media/Makefile`` for an example
21 NAME  chapter
25 parse_headers.pl - parse a C file, in order to identify functions, structs,
26 enums and defines and create cross-references to a Sphinx book.
35 Where <options> can be: --debug, --help or --usage.
43 \ **--debug**\
49 \ **--usage**\
55 \ **--help**\
64 Convert a C header or source file (C_FILE), into a reStructuredText
65 included via ..parsed-literal block with cross-references for the
68 be pointed to a non-default reference.
73 enums and enum symbols and create cross-references for all of them.
82 ignore \ **type**\  \ **name**\
85 \ **name**\  symbol of type \ **type**\ .
90 replace \ **type**\  \ **name**\  \ **new_value**\
93 \ **name**\  symbol of type \ **type**\ , but, instead of using the default
122  The ignore or replace statement will apply to the name of struct statements
129  The ignore or replace statement will apply to the name of enum statements
136  The ignore or replace statement will apply to the name of enum value
139  For replace statements, \ **new_value**\  will automatically use :c:type:
162 It won't generate cross-references for \ **PRIVATE**\ .
164 replace symbol BAR1 :c:type:\`foo\`
165 replace symbol BAR2 :c:type:\`foo\`
173 symbol at the C domain.
187 Copyright (c) 2016 by Mauro Carvalho Chehab <mchehab+samsung@kernel.org>.
189 License GPLv2: GNU GPL version 2 <https://gnu.org/licenses/gpl.html>.