From c77fdb48641c79f173fba3141015f102ee5d1326 Mon Sep 17 00:00:00 2001 From: Pauli Virtanen Date: Sat, 4 Nov 2023 12:35:30 +0200 Subject: [PATCH] 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. --- doc/Doxyfile.in | 2 +- doc/DoxygenLayout.xml | 20 ++++++++++---------- doc/api-tree.dox | 4 ---- doc/custom.css | 12 ++++++++++++ doc/manpage.dox.in | 2 ++ doc/meson.build | 9 +++++---- 6 files changed, 30 insertions(+), 19 deletions(-) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index b6004c789..bbf2b4ad1 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1,7 +1,7 @@ PROJECT_NAME = PipeWire PROJECT_NUMBER = @PACKAGE_VERSION@ OUTPUT_DIRECTORY = "@output_directory@" -FULL_PATH_NAMES = NO +FULL_PATH_NAMES = YES JAVADOC_AUTOBRIEF = YES TAB_SIZE = 8 OPTIMIZE_OUTPUT_FOR_C = YES diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index 65bfc9573..29378f9da 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -1,37 +1,37 @@ - + - + - + - + - + - + - + - + @@ -185,12 +185,12 @@ - + @@ -206,12 +206,12 @@ - + diff --git a/doc/api-tree.dox b/doc/api-tree.dox index 88259af72..d0f22aa1b 100644 --- a/doc/api-tree.dox +++ b/doc/api-tree.dox @@ -120,8 +120,4 @@ Support interfaces provided by host \{ \} -\defgroup pwtest Test Suite -\{ -\} - */ diff --git a/doc/custom.css b/doc/custom.css index a9cff0a20..ace3e1c71 100644 --- a/doc/custom.css +++ b/doc/custom.css @@ -22,3 +22,15 @@ opacity: 1; 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; +} diff --git a/doc/manpage.dox.in b/doc/manpage.dox.in index 9e6df7893..3a92f6fbe 100644 --- a/doc/manpage.dox.in +++ b/doc/manpage.dox.in @@ -1,5 +1,7 @@ /** \page @pagename@ @title@ +\brief Manual page for @title@ + \verbinclude @filename@ */ diff --git a/doc/meson.build b/doc/meson.build index 1fdca64f5..c79b22824 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -68,7 +68,6 @@ endforeach foreach h : module_sources inputs += meson.project_source_root() / 'src' / 'modules' / h endforeach -inputs += meson.project_source_root() / 'test' / 'pwtest.h' input_dirs = [ meson.project_source_root() / 'spa' / 'include' / 'spa' ] path_prefixes = [ @@ -142,13 +141,15 @@ pw_tools_dox = configure_file(input: 'pipewire-tools.dox.in', input_dirs += [ 'doc/pipewire-tools.dox' ] 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('cssfiles', ' '.join(cssfiles)) doxyfile_conf.set('layout', doxygen_layout) 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('h_input_filter', meson.project_source_root() / 'doc' / 'input-filter-h.sh') +doxyfile_conf.set('c_input_filter', doxygen_filter_c) +doxyfile_conf.set('h_input_filter', doxygen_filter_h) doxyfile = configure_file(input: 'Doxyfile.in', output: 'Doxyfile', @@ -160,7 +161,7 @@ if docdir == '' endif 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' ], command: [ doxygen, doxyfile ], install: true,