mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-12-16 08:56:45 -05:00
doc: hide useless indices in doxygen output etc. fixes
Hide useless paginated indices. Rename "Related Pages" -> "Pages". Fix manpage brief description. Fix file path name stripping. Move macro listings after enums, so that they're next to functions. Remove pwtest from docs, it's not API. Fixup header styles.
This commit is contained in:
parent
27afa39d5d
commit
c77fdb4864
6 changed files with 30 additions and 19 deletions
|
|
@ -1,7 +1,7 @@
|
||||||
PROJECT_NAME = PipeWire
|
PROJECT_NAME = PipeWire
|
||||||
PROJECT_NUMBER = @PACKAGE_VERSION@
|
PROJECT_NUMBER = @PACKAGE_VERSION@
|
||||||
OUTPUT_DIRECTORY = "@output_directory@"
|
OUTPUT_DIRECTORY = "@output_directory@"
|
||||||
FULL_PATH_NAMES = NO
|
FULL_PATH_NAMES = YES
|
||||||
JAVADOC_AUTOBRIEF = YES
|
JAVADOC_AUTOBRIEF = YES
|
||||||
TAB_SIZE = 8
|
TAB_SIZE = 8
|
||||||
OPTIMIZE_OUTPUT_FOR_C = YES
|
OPTIMIZE_OUTPUT_FOR_C = YES
|
||||||
|
|
|
||||||
|
|
@ -1,37 +1,37 @@
|
||||||
<doxygenlayout version="1.0">
|
<doxygenlayout version="1.0">
|
||||||
<navindex>
|
<navindex>
|
||||||
<tab type="mainpage" visible="yes" title=""/>
|
<tab type="mainpage" visible="yes" title=""/>
|
||||||
<tab type="pages" visible="yes" title="" intro=""/>
|
<tab type="pages" visible="yes" title="Pages" intro=""/>
|
||||||
<tab type="modules" visible="yes" title="API Reference" intro="" />
|
<tab type="modules" visible="yes" title="API Reference" intro="" />
|
||||||
<tab type="namespaces" visible="no" title="">
|
<tab type="namespaces" visible="no" title="">
|
||||||
<tab type="namespacelist" visible="yes" title="" intro=""/>
|
<tab type="namespacelist" visible="yes" title="" intro=""/>
|
||||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||||
</tab>
|
</tab>
|
||||||
<tab type="concepts" visible="yes" title="">
|
<tab type="concepts" visible="no" title="">
|
||||||
</tab>
|
</tab>
|
||||||
<tab type="interfaces" visible="yes" title="">
|
<tab type="interfaces" visible="no" title="">
|
||||||
<tab type="interfacelist" visible="yes" title="" intro=""/>
|
<tab type="interfacelist" visible="yes" title="" intro=""/>
|
||||||
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||||
<tab type="interfacehierarchy" visible="yes" title="" intro=""/>
|
<tab type="interfacehierarchy" visible="yes" title="" intro=""/>
|
||||||
</tab>
|
</tab>
|
||||||
<tab type="classes" visible="yes" title="">
|
<tab type="classes" visible="yes" title="">
|
||||||
<tab type="classlist" visible="yes" title="" intro=""/>
|
<tab type="classlist" visible="yes" title="" intro=""/>
|
||||||
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
<tab type="classindex" visible="yes" title=""/>
|
||||||
<tab type="hierarchy" visible="yes" title="" intro=""/>
|
<tab type="hierarchy" visible="yes" title="" intro=""/>
|
||||||
<tab type="classmembers" visible="yes" title="" intro=""/>
|
<tab type="classmembers" visible="no" title="" intro=""/>
|
||||||
</tab>
|
</tab>
|
||||||
<tab type="structs" visible="yes" title="">
|
<tab type="structs" visible="no" title="">
|
||||||
<tab type="structlist" visible="yes" title="" intro=""/>
|
<tab type="structlist" visible="yes" title="" intro=""/>
|
||||||
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||||
</tab>
|
</tab>
|
||||||
<tab type="exceptions" visible="yes" title="">
|
<tab type="exceptions" visible="no" title="">
|
||||||
<tab type="exceptionlist" visible="yes" title="" intro=""/>
|
<tab type="exceptionlist" visible="yes" title="" intro=""/>
|
||||||
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||||
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
|
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
|
||||||
</tab>
|
</tab>
|
||||||
<tab type="files" visible="yes" title="">
|
<tab type="files" visible="yes" title="">
|
||||||
<tab type="filelist" visible="yes" title="" intro=""/>
|
<tab type="filelist" visible="yes" title="" intro=""/>
|
||||||
<tab type="globals" visible="yes" title="" intro=""/>
|
<tab type="globals" visible="no" title="" intro=""/>
|
||||||
</tab>
|
</tab>
|
||||||
<tab type="examples" visible="yes" title="" intro=""/>
|
<tab type="examples" visible="yes" title="" intro=""/>
|
||||||
</navindex>
|
</navindex>
|
||||||
|
|
@ -185,12 +185,12 @@
|
||||||
<namespaces visible="yes" title=""/>
|
<namespaces visible="yes" title=""/>
|
||||||
<concepts visible="yes" title=""/>
|
<concepts visible="yes" title=""/>
|
||||||
<classes visible="yes" title=""/>
|
<classes visible="yes" title=""/>
|
||||||
<defines title=""/>
|
|
||||||
<typedefs title=""/>
|
<typedefs title=""/>
|
||||||
<sequences title=""/>
|
<sequences title=""/>
|
||||||
<dictionaries title=""/>
|
<dictionaries title=""/>
|
||||||
<enums title=""/>
|
<enums title=""/>
|
||||||
<enumvalues title=""/>
|
<enumvalues title=""/>
|
||||||
|
<defines title=""/>
|
||||||
<functions title=""/>
|
<functions title=""/>
|
||||||
<variables title=""/>
|
<variables title=""/>
|
||||||
<signals title=""/>
|
<signals title=""/>
|
||||||
|
|
@ -206,12 +206,12 @@
|
||||||
<memberdef>
|
<memberdef>
|
||||||
<pagedocs/>
|
<pagedocs/>
|
||||||
<inlineclasses title=""/>
|
<inlineclasses title=""/>
|
||||||
<defines title=""/>
|
|
||||||
<typedefs title=""/>
|
<typedefs title=""/>
|
||||||
<sequences title=""/>
|
<sequences title=""/>
|
||||||
<dictionaries title=""/>
|
<dictionaries title=""/>
|
||||||
<enums title=""/>
|
<enums title=""/>
|
||||||
<enumvalues title=""/>
|
<enumvalues title=""/>
|
||||||
|
<defines title=""/>
|
||||||
<functions title=""/>
|
<functions title=""/>
|
||||||
<variables title=""/>
|
<variables title=""/>
|
||||||
<signals title=""/>
|
<signals title=""/>
|
||||||
|
|
|
||||||
|
|
@ -120,8 +120,4 @@ Support interfaces provided by host
|
||||||
\{
|
\{
|
||||||
\}
|
\}
|
||||||
|
|
||||||
\defgroup pwtest Test Suite
|
|
||||||
\{
|
|
||||||
\}
|
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
|
|
@ -22,3 +22,15 @@
|
||||||
opacity: 1;
|
opacity: 1;
|
||||||
padding-right: 0.25em;
|
padding-right: 0.25em;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.textblock h1 {
|
||||||
|
font-size: 150%;
|
||||||
|
}
|
||||||
|
.textblock h2 {
|
||||||
|
font-size: 100%;
|
||||||
|
}
|
||||||
|
.textblock h3, .textblock h4, .textblock h5, .textblock h6 {
|
||||||
|
font-size: 100%;
|
||||||
|
font-style: italic;
|
||||||
|
font-size: medium;
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,7 @@
|
||||||
/** \page @pagename@ @title@
|
/** \page @pagename@ @title@
|
||||||
|
|
||||||
|
\brief Manual page for @title@
|
||||||
|
|
||||||
\verbinclude @filename@
|
\verbinclude @filename@
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
|
|
@ -68,7 +68,6 @@ endforeach
|
||||||
foreach h : module_sources
|
foreach h : module_sources
|
||||||
inputs += meson.project_source_root() / 'src' / 'modules' / h
|
inputs += meson.project_source_root() / 'src' / 'modules' / h
|
||||||
endforeach
|
endforeach
|
||||||
inputs += meson.project_source_root() / 'test' / 'pwtest.h'
|
|
||||||
input_dirs = [ meson.project_source_root() / 'spa' / 'include' / 'spa' ]
|
input_dirs = [ meson.project_source_root() / 'spa' / 'include' / 'spa' ]
|
||||||
|
|
||||||
path_prefixes = [
|
path_prefixes = [
|
||||||
|
|
@ -142,13 +141,15 @@ pw_tools_dox = configure_file(input: 'pipewire-tools.dox.in',
|
||||||
input_dirs += [ 'doc/pipewire-tools.dox' ]
|
input_dirs += [ 'doc/pipewire-tools.dox' ]
|
||||||
|
|
||||||
doxygen_layout = meson.project_source_root() / 'doc' / 'DoxygenLayout.xml'
|
doxygen_layout = meson.project_source_root() / 'doc' / 'DoxygenLayout.xml'
|
||||||
|
doxygen_filter_c = meson.project_source_root() / 'doc' / 'input-filter.sh'
|
||||||
|
doxygen_filter_h = meson.project_source_root() / 'doc' / 'input-filter-h.sh'
|
||||||
|
|
||||||
doxyfile_conf.set('inputs', ' '.join(inputs + input_dirs))
|
doxyfile_conf.set('inputs', ' '.join(inputs + input_dirs))
|
||||||
doxyfile_conf.set('cssfiles', ' '.join(cssfiles))
|
doxyfile_conf.set('cssfiles', ' '.join(cssfiles))
|
||||||
doxyfile_conf.set('layout', doxygen_layout)
|
doxyfile_conf.set('layout', doxygen_layout)
|
||||||
doxyfile_conf.set('path_prefixes', ' '.join(path_prefixes))
|
doxyfile_conf.set('path_prefixes', ' '.join(path_prefixes))
|
||||||
doxyfile_conf.set('c_input_filter', meson.project_source_root() / 'doc' / 'input-filter.sh')
|
doxyfile_conf.set('c_input_filter', doxygen_filter_c)
|
||||||
doxyfile_conf.set('h_input_filter', meson.project_source_root() / 'doc' / 'input-filter-h.sh')
|
doxyfile_conf.set('h_input_filter', doxygen_filter_h)
|
||||||
|
|
||||||
doxyfile = configure_file(input: 'Doxyfile.in',
|
doxyfile = configure_file(input: 'Doxyfile.in',
|
||||||
output: 'Doxyfile',
|
output: 'Doxyfile',
|
||||||
|
|
@ -160,7 +161,7 @@ if docdir == ''
|
||||||
endif
|
endif
|
||||||
|
|
||||||
html_target = custom_target('pipewire-docs',
|
html_target = custom_target('pipewire-docs',
|
||||||
input: [ doxyfile, doxygen_layout, examples_dox, pw_tools_dox ] + inputs + cssfiles + man_doxygen,
|
input: [ doxyfile, doxygen_layout, examples_dox, pw_tools_dox, doxygen_filter_c, doxygen_filter_h ] + inputs + cssfiles + man_doxygen,
|
||||||
output: [ 'html' ],
|
output: [ 'html' ],
|
||||||
command: [ doxygen, doxyfile ],
|
command: [ doxygen, doxyfile ],
|
||||||
install: true,
|
install: true,
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue