Commit graph

289 commits

Author SHA1 Message Date
Marcus Weseloh
4a7d7ad688 Settings reference style more consistent with rest of reference pages 2020-11-16 22:29:42 +01:00
Marcus Weseloh
602a2bcdc1 Remove unused command alias and sync Doxyfile.cmake and Doxyfile 2020-11-16 22:09:06 +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
a279b2b397 Make top links black on hover, not white 2020-11-14 17:10:06 +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
4ea5d64eb7 Rename setting reference page name to lowercase, for consistency 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
d00849b556 Restructure devdocs into separate pages 2020-11-12 21:23:31 +01:00
Marcus Weseloh
339b30c946 Move doxygen customizations into separate directory 2020-11-12 21:23:31 +01:00
Marcus Weseloh
d1237c4678 Make larger enums easier to read 2020-11-12 21:23:31 +01:00
Marcus Weseloh
cfa9e7bedc Enable navigation sidebar 2020-11-12 21:23:31 +01:00
Marcus Weseloh
93b3375fe3 Remove "References" and "Referenced by" links from doc
They auto generated links are quite long on some functions, making
the documentation harder to read.
2020-11-12 21:23:31 +01:00
Marcus Weseloh
ae145daf72 Remove FLUIDSYNTH_API and FLUID_DEPRECATED macros from documentation 2020-11-12 21:23:15 +01:00
Marcus Weseloh
c18e008d70 Options seems to be more widely used, so use that instead of Choices 2020-11-02 19:37:14 +01:00
Marcus Weseloh
54e164426f As gs is default for midi-bank-select, list it as first option for clarity 2020-11-02 19:33:08 +01:00
Marcus Weseloh
f1d760f02c Update ladspa.active description
Use 1 (TRUE) for consistency and mention LADSPA documentation
2020-11-02 19:32:37 +01:00
Marcus Weseloh
f3390e8049 Update effects-groups description to avoid the word "unit" 2020-11-02 19:31:54 +01:00
Marcus Weseloh
4fef48e740 Better explain currently unused effects-channels 2020-11-02 19:31:31 +01:00
Marcus Weseloh
f2d0789b26 Consistently format all floats 2020-11-02 19:30:24 +01:00
Marcus Weseloh
d14c9edc4f Update periods and period-size with current values from source 2020-11-02 19:05:36 +01:00
Marcus Weseloh
cd4376dfea shell.port is an int setting, not num 2020-11-02 19:00:35 +01:00