Commit graph

2341 commits

Author SHA1 Message Date
Marcus Weseloh
602a2bcdc1 Remove unused command alias and sync Doxyfile.cmake and Doxyfile 2020-11-16 22:09:06 +01:00
Marcus Weseloh
c7f9d05190
GitHub Action to build the API docs from master branch (#704)
Uploads the complete HTML API docs as an artifact called api_docs.zip
2020-11-16 15:27:56 +01:00
Marcus Weseloh
9971f9372c Workaround for doxygen bug with linebreaks in ALIASES
Using \_linebr is not ideal, as it's an internal command. But that
seems to be the most compatible way to specify line breaks in ALIASES
accross different doxygen versions at the moment.
2020-11-15 00:31:32 +01:00
Marcus Weseloh
42f91986cd Use SVG for fluid mixer image 2020-11-14 21:16:23 +01:00
Marcus Weseloh
7d994ff9be Add intro text to deprecated list 2020-11-14 18:46:17 +01:00
Marcus Weseloh
0a23598126 Remove obsolete doxygen config options 2020-11-14 18:32:39 +01:00
Marcus Weseloh
3d930ffda4 Remove debug leftover 2020-11-14 17:12:39 +01:00
Marcus Weseloh
36280b9788 Add missing group brief descriptions 2020-11-14 17:10:26 +01:00
Marcus Weseloh
a279b2b397 Make top links black on hover, not white 2020-11-14 17:10:06 +01:00
Marcus Weseloh
961579774d Add documentation hints to style guide 2020-11-14 16:59:25 +01:00
Marcus Weseloh
d0db0cc119 Document how to revert the styling and layout changes 2020-11-14 16:27:43 +01:00
Marcus Weseloh
6113c15f94 Improve styling of field tables (enum values) 2020-11-14 16:22:50 +01:00
Marcus Weseloh
a03362a155 Style improvements for small screens
- hide side nav
- hide search box
- make content full height
2020-11-14 16:13:10 +01:00
Marcus Weseloh
5ccc7543ae Hide nav sync toggle button 2020-11-14 16:12:17 +01:00
Marcus Weseloh
3c1c796396 Add generated fluidsettings.txt for fluidsynth.org API doc build
Probably not the final solution, but works for now.
2020-11-14 15:10:57 +01:00
Marcus Weseloh
eebbfb6a62 Smaller cleanup and reformatting of long lines. 2020-11-14 14:59:29 +01:00
Marcus Weseloh
b565b3ebc3 Use custom \setting{} alias to link to fluid settings 2020-11-14 14:56:18 +01:00
Marcus Weseloh
0f9aed6f83 Use \image for images and improve quality of FluidMixer image 2020-11-14 14:25:44 +01:00
Marcus Weseloh
cb16f8d32d Split HTML_EXTRA_FILEs into separate lines 2020-11-14 14:04:05 +01:00
Marcus Weseloh
c4512367c4 Move examples into doc/examples directory 2020-11-14 13:40:46 +01:00
Marcus Weseloh
20ec6f3376 Move usage guide pages into separate files in doc/usage 2020-11-14 13:26:05 +01:00
Marcus Weseloh
67cb344a20 Move recent changes into separate file 2020-11-14 13:23:55 +01:00
Marcus Weseloh
cc84da2094 Split doxygen INPUT into separate lines, for easier readability 2020-11-14 13:21:57 +01:00
Marcus Weseloh
3c68eaa619 Sync the static Doxyfile with Doxyfile.cmake
Still missing is the integration of the generated fluidsettings.txt,
as that requires a build script currently not available on the
server generating the public API docs.
2020-11-13 23:21:47 +01:00
Marcus Weseloh
2a2027085e Separate new_* and delete_* functions from the rest 2020-11-13 22:23:29 +01:00
Marcus Weseloh
ee2ac9e1d9 Mark settings with callbacks as realtime and output this in the generated docs 2020-11-13 20:46:02 +01:00
Marcus Weseloh
1d9d7e9042 Also update the styling of the deprecated list 2020-11-12 22:31:19 +01:00
Marcus Weseloh
d2a29ec4c5 Make sure libxslt is only searched if doxygen is available as well 2020-11-12 21:50:35 +01:00
Marcus Weseloh
5a70df1cb7 Remove footer, as it takes away valuable vertical space 2020-11-12 21:27:00 +01:00
Marcus Weseloh
921c0e08c0 Updated documentation styling 2020-11-12 21:27:00 +01:00
Marcus Weseloh
d4741b7d5e Sort groups/modules, briefs and members 2020-11-12 21:27:00 +01:00
Marcus Weseloh
f5900a261f Custom doxygen layout to rename modules to API Reference 2020-11-12 21:27:00 +01:00
Marcus Weseloh
512f39b1a1 Some more brief message abbreviation hints 2020-11-12 21:27:00 +01:00
Marcus Weseloh
48761ea724 Consistent capitalization of usage guide section names 2020-11-12 21:27:00 +01:00
Marcus Weseloh
a9135faf70 Structure the large synth header into subgroups
Also include version.h and ladspa.h in the Synthesizer group.
2020-11-12 21:27:00 +01:00
Marcus Weseloh
4ea5d64eb7 Rename setting reference page name to lowercase, for consistency 2020-11-12 21:27:00 +01:00
Marcus Weseloh
6780293d0c Add version defines and functions to misc group 2020-11-12 21:27:00 +01:00
Marcus Weseloh
9248032feb SoundFont API
Includes Generators, Modulators, Loader etc
2020-11-12 21:27:00 +01:00
Marcus Weseloh
7f1ac22869 Miscellaneous group 2020-11-12 21:27:00 +01:00
Marcus Weseloh
4a40695541 Settings documentation 2020-11-12 21:27:00 +01:00
Marcus Weseloh
39ae70793a MIDI Seqencer documentation 2020-11-12 21:27:00 +01:00
Marcus Weseloh
4185b25d6f MIDI input group
Contains MIDI Driver, MIDI Router, MIDI Player and MIDI Events
2020-11-12 21:27:00 +01:00
Marcus Weseloh
bae3dec78a Logging interface 2020-11-12 21:27:00 +01:00
Marcus Weseloh
66b7c19893 Audio output group
With subgroups Audio Driver and File Renderer
2020-11-12 21:27:00 +01:00
Marcus Weseloh
af68288628 Command Shell group for all shell related commands
With subgroups for command handler, shell and server.
2020-11-12 21:27:00 +01:00
Marcus Weseloh
8617e53a00 Replace all links to fluidsettings.xml with proper \ref's 2020-11-12 21:23:31 +01:00
Marcus Weseloh
c5b50455d7 Use xsltproc to include settings in API documentation 2020-11-12 21:23:31 +01:00
Marcus Weseloh
272cc5edad Some additional subgrouping 2020-11-12 21:23:31 +01:00
Marcus Weseloh
a11806aa32 Change files into groups / modules 2020-11-12 21:23:31 +01:00
Marcus Weseloh
d00849b556 Restructure devdocs into separate pages 2020-11-12 21:23:31 +01:00