doc: reorganize files

Separate various autogen files from the documentation .dox files.
Rename .dox files to match the intended tree structure.

doc/dox/api/index.dox

@@ -59,6 +59,7 @@ digraph API {
 It is common for clients to use both the \ref api_pw_core and the \ref api_pw_impl
 and both APIs are provided by the same library.
 
+- \subpage page_spa
 - \subpage page_client_impl
 - \subpage page_proxy
 - \subpage page_streams

doc/dox/index.dox

@@ -17,7 +17,7 @@ PipeWire ships with the following components:
 
 - A \ref page_daemon that implements the IPC and graph processing.
 - An example \ref page_session_manager that manages objects in the \ref page_daemon.
-- A set of \ref page_tools to introspect and use the \ref page_daemon.
+- A set of \ref page_programs to introspect and use the \ref page_daemon.
 - A \ref page_library to develop PipeWire applications and plugins (\ref
   page_tutorial "tutorial").
 - The \ref page_spa used by both the \ref page_daemon and in the \ref
@@ -43,13 +43,4 @@ More information on how to configure and use PipeWire.
 - [Intoduction to PipeWire](https://bootlin.com/blog/an-introduction-to-pipewire/)
 - [A custom PipeWire node](https://bootlin.com/blog/a-custom-pipewire-node/)
 
-
-\page page_overview
-\page page_pipewire
-\page page_tools
-\page page_pipewire_modules
-\page page_api
-\page page_spa
-\page page_tutorial
-
 */

doc/dox/internals/index.dox

@@ -1,4 +1,4 @@
-/** \page page_pipewire PipeWire Design
+/** \page page_internals Internals
 
 # Internals
 

doc/dox/modules.dox

@@ -1,4 +1,4 @@
-/** \page page_pipewire_modules PipeWire Modules
+/** \page page_modules Modules
 
 A PipeWire module is effectively a PipeWire client in an `.so` file that
 shares the \ref pw_context with the loading entity. Usually modules are

doc/dox/tutorial/index.dox

@@ -1,6 +1,6 @@
 /** \page page_tutorial Tutorial
 
-Welcome to the PipeWire tutorial. The goal is to learn
+Welcome to the PipeWire API tutorial. The goal is to learn
 PipeWire API step-by-step with simple short examples.
 
 - \subpage page_tutorial1

doc/meson.build

@@ -14,39 +14,39 @@ else
 endif
 
 # Note: order here is how doxygen will expose the pages in the sidebar
-# api-tree.dox should be first to determine ordering of Modules.
+# tree.dox should be first to determine the ordering.
 extra_docs = [
-  'api-tree.dox',
+  'tree.dox',
-  'index.dox',
+  'dox/index.dox',
-  'overview.dox',
+  'dox/overview.dox',
-  'pipewire.dox',
+  'dox/modules.dox',
-  'pipewire-design.dox',
+  'dox/internals/index.dox',
-  'pipewire-access.dox',
+  'dox/internals/design.dox',
-  'pipewire-midi.dox',
+  'dox/internals/access.dox',
-  'pipewire-portal.dox',
+  'dox/internals/midi.dox',
-  'pipewire-daemon.dox',
+  'dox/internals/portal.dox',
-  'pipewire-library.dox',
+  'dox/internals/daemon.dox',
-  'pipewire-modules.dox',
+  'dox/internals/library.dox',
-  'pipewire-session-manager.dox',
+  'dox/internals/session-manager.dox',
-  'pipewire-objects-design.dox',
+  'dox/internals/objects.dox',
-  'pipewire-audio.dox',
+  'dox/internals/audio.dox',
-  'pipewire-scheduling.dox',
+  'dox/internals/scheduling.dox',
-  'pipewire-protocol.dox',
+  'dox/internals/protocol.dox',
-  'tutorial.dox',
+  'dox/internals/pulseaudio.dox',
-  'tutorial1.dox',
+  'dox/internals/dma-buf.dox',
-  'tutorial2.dox',
+  'dox/tutorial/index.dox',
-  'tutorial3.dox',
+  'dox/tutorial/tutorial1.dox',
-  'tutorial4.dox',
+  'dox/tutorial/tutorial2.dox',
-  'tutorial5.dox',
+  'dox/tutorial/tutorial3.dox',
-  'tutorial6.dox',
+  'dox/tutorial/tutorial4.dox',
-  'api.dox',
+  'dox/tutorial/tutorial5.dox',
-  'spa-index.dox',
+  'dox/tutorial/tutorial6.dox',
-  'spa-plugins.dox',
+  'dox/api/index.dox',
-  'spa-design.dox',
+  'dox/api/spa-index.dox',
-  'spa-pod.dox',
+  'dox/api/spa-plugins.dox',
-  'spa-buffer.dox',
+  'dox/api/spa-design.dox',
-  'pulseaudio.dox',
+  'dox/api/spa-pod.dox',
-  'dma-buf.dox',
+  'dox/api/spa-buffer.dox',
 ]
 
 inputs = []
@@ -133,12 +133,12 @@ foreach m : manpages
   input_dirs += [ 'doc/' + filename ]
 endforeach
 
-pw_tools_dox_conf = configuration_data()
+pw_programs_dox_conf = configuration_data()
-pw_tools_dox_conf.set('man_subpages', '\n'.join(man_subpages))
+pw_programs_dox_conf.set('man_subpages', '\n'.join(man_subpages))
-pw_tools_dox = configure_file(input: 'pipewire-tools.dox.in',
+pw_programs_dox = configure_file(input: 'programs.dox.in',
-                          output: 'pipewire-tools.dox',
+                          output: 'programs.dox',
-                          configuration: pw_tools_dox_conf)
+                          configuration: pw_programs_dox_conf)
-input_dirs += [ 'doc/pipewire-tools.dox' ]
+input_dirs += [ 'doc/programs.dox' ]
 
 doxygen_layout = meson.project_source_root() / 'doc' / 'DoxygenLayout.xml'
 doxygen_filter_c = meson.project_source_root() / 'doc' / 'input-filter.sh'
@@ -161,7 +161,7 @@ if docdir == ''
 endif
 
 html_target = custom_target('pipewire-docs',
-                            input: [ doxyfile, doxygen_layout, examples_dox, pw_tools_dox, doxygen_filter_c, doxygen_filter_h ] + inputs + cssfiles + man_doxygen,
+                            input: [ doxyfile, doxygen_layout, examples_dox, pw_programs_dox, doxygen_filter_c, doxygen_filter_h ] + inputs + cssfiles + man_doxygen,
                             output: [ 'html' ],
                             command: [ doxygen, doxyfile ],
                             install: true,

doc/pipewire-tools.dox.in

@@ -1,7 +0,0 @@
-/** \page page_tools PipeWire Tools
-
-Manual pages:
-
-@man_subpages@
-
-*/

doc/programs.dox.in

@@ -0,0 +1,7 @@
+/** \page page_programs Programs
+
+Manual pages:
+
+@man_subpages@
+
+*/

doc/tree.dox

@@ -1,5 +1,7 @@
 /**
 
+This determines the ordering of items in Doxygen sidebar.
+
 \defgroup api_pw_core Core API
 \brief PipeWire Core API
 \{
@@ -120,4 +122,11 @@ Support interfaces provided by host
 \{
 \}
 
+\page page_overview
+\page page_modules
+\page page_programs
+\page page_internals
+\page page_api
+\page page_tutorial
+
 */