From 2aa2ce24207d2e495dbe9d2cc3656229aa768f19 Mon Sep 17 00:00:00 2001 From: Chris Xiong Date: Fri, 8 Nov 2019 01:34:09 +0800 Subject: Documentation update time! --- doc/APIdoc.md | 4 ++-- doc/channeldialog.html | 12 ++++++------ doc/channeleditor.html | 20 ++++++++++---------- doc/cmdargs.html | 16 +++++++++++----- doc/efxdialog.html | 2 +- doc/mainwindow.html | 31 +++++++++++++++++-------------- doc/miscellaneous.html | 32 +++++++++++++++----------------- doc/optionsdialog.html | 24 +++++++++++++----------- doc/plistdialog.html | 2 +- doc/troubleshooting.html | 32 ++++++++++++++++++++++++++++---- doc/version.html | 2 +- doc/visualization.html | 5 ----- 12 files changed, 105 insertions(+), 77 deletions(-) (limited to 'doc') diff --git a/doc/APIdoc.md b/doc/APIdoc.md index 968aa97..8e3a181 100644 --- a/doc/APIdoc.md +++ b/doc/APIdoc.md @@ -74,7 +74,7 @@ Hooks use the universal `ICallBack` interface. Some of those also accept a point When you register a hook, you provide the core with a instance of your class that implements the `ICallBack` interface and your `userdata` to be used when the core is calling the callback. When the callback is called, it will be fed with proper `callerdata` generated by the core and the `userdata` you provided. Type of `callerdata` varies by hooks. Event -reader and handler hooks have `SEventCallBackData*` as their `callerdata`. All other callbacks at this time have `NULL` +reader and handler hooks have `SEventCallBackData*` as their `callerdata`. All other callbacks at this time have `nullptr` as their `callerdata`. **Don't try directly modifying the members of callerdata!** # 4. Functionalities @@ -152,7 +152,7 @@ type of the event together with the channel this event goes to. Contains the raw data for string-like events. - default constructor: `SEvent()` sets everything to zero or empty. -- constructor with parameters: `SEvent(uint32_t _iid,uint32_t _t,char _tp,uint32_t _p1,uint32_t _p2,const char* s=NULL)` +- constructor with parameters: `SEvent(uint32_t _iid,uint32_t _t,char _tp,uint32_t _p1,uint32_t _p2,const char* s=nullptr)` fills the event with the parameters given. - `friend bool operator <(const SEvent& a,const SEvent& b)` compares events by their timestamps. Ties are broken by comparing precedence in file. diff --git a/doc/channeldialog.html b/doc/channeldialog.html index c1674a1..6b722f6 100644 --- a/doc/channeldialog.html +++ b/doc/channeldialog.html @@ -24,22 +24,22 @@

Channel Dialog

-
+

Columns in the channel table

Buttons


Return
diff --git a/doc/channeleditor.html b/doc/channeleditor.html index 0c38d54..55b5378 100644 --- a/doc/channeleditor.html +++ b/doc/channeleditor.html @@ -24,26 +24,26 @@

Channel Editor

-
+

Controllers Explained

Notes


Return
diff --git a/doc/cmdargs.html b/doc/cmdargs.html index afc770d..dbce315 100644 --- a/doc/cmdargs.html +++ b/doc/cmdargs.html @@ -24,11 +24,17 @@ 
-Usage: qmidiplayer [Options] [Midi Files]
-Possible options are: 
-  -l, --load-all-files  Load all files from the same folder.
-  --help                Show this help and exit.
-  --version             Show this version information and exit.
+Usage: ./qmidiplayer [options] [files...]
+A cross-platform MIDI player.
+
+Options:
+  -h, --help                 Displays this help.
+  -v, --version              Displays version information.
+  --plugin <plugin library>  Load a plugin from <plugin library>.
+  -l, --load-all-files       Load all files from the same folder.
+
+Arguments:
+  file                       midi files to play (optional).

Return
diff --git a/doc/efxdialog.html b/doc/efxdialog.html index 1706fc7..e1612e4 100644 --- a/doc/efxdialog.html +++ b/doc/efxdialog.html @@ -24,7 +24,7 @@

Effects Dialog

-
+
Adjest effect parameters of the internal fluidsynth here.

Main Window

-
- +
+
    +
  1. Now playing. Right clicking here will bring up the action menu.
    2. +
  2. Seeking slider. Song length is estimated and may not be 100% accurate.
    3. +
  3. Playback control buttons. Self-explanatory.
    4. +
  4. Open file.
    5. +
  5. Settings button. Refer to the Settings section for details.
    6. +
  6. Dialog buttons. You can configure this section in settings.
    7. +
  7. FluidSynth master gain slider.
    8. +
  8. FluidSynth polyphony indicator.
    9. +
  9. A dumb button.
    10. +

File operation menu

+

+ Note that actual actions in this menu can be configured in settings. +


Return diff --git a/doc/miscellaneous.html b/doc/miscellaneous.html index 7f46d33..481e1a6 100644 --- a/doc/miscellaneous.html +++ b/doc/miscellaneous.html @@ -30,14 +30,7 @@
  • Contact the author

    • Building QMidiPlayer from source

    - Building QMidiPlayer from source is as easy as any other qmake projects.
    - 1. Get the dependencies.
    - Currently QMidiPlayer depends on these libraries:
    - 
    qt5, libfluidsynth(FluidSynth), librtmidi(RtMidi)
    - If you want to build the lite version as well, you need several QML core modules.
    - Get the libraries for your platform, open the project with Qt Creator, configure and hit Build! - (You may also use the qmake-make way).
    - Please note that QMidiPlayer requires C++11 to build. + Checkout INSTALL.md in the project root directory.

    Roadmap/Milestones

    @@ -56,7 +50,7 @@ Visual Studio 2015 Runtime Library.

    - Nighly builds are compiled with MSVC2017 (using Qt MSVC2015 x86, though). So you need two runtime libraries + (Older) Nighly builds are compiled with MSVC2017 (using Qt MSVC2015 x86, though). So you need two runtime libraries to run it. Damn.

    @@ -75,19 +69,23 @@

    3. On what platform(s) do you develop this project?

    Major platforms used: -

    - Platforms for building the Windows version: - + + Platforms for building the Windows version: +

    4. The code is full of shit and has no comment at all!

    I know. I got pissed off for that everytime.

    +

    5. Do you have any plan to release binaries for macOS?

    +

    + No. +

    Contact the author

    E-mail: chirs241097 'at' gmail 'dot' com
    diff --git a/doc/optionsdialog.html b/doc/optionsdialog.html index 8bbf79b..24a6ca7 100644 --- a/doc/optionsdialog.html +++ b/doc/optionsdialog.html @@ -24,15 +24,11 @@

    Settings Dialog

    - Settings are stored in $HOME/.config/qmprc
    - For Windows users, $HOME refers to X:\Users\<your user name>\.config, where X is the system drive of your - Windows installation.
    - Options with one asterisk will be applied after restarting QMidiPlayer.
    + Options with one asterisk will be applied after QMidiPlayer is restarted.
    Options with two asterisks will be applied after the internal fluidsynth is restarted.
    Other options are applied immediately.
    -
    +
    -
    +
    -
    - You can manage soundfont used by the internal fluidsynth engine here.
    +
    + You can manage a list of soundfonts used by the internal fluidsynth engine here. Unchecked + soundfonts will not be used.
    If multiple soundfonts provide instruments with the same bank numbers and preset numbers, the preset provided by the top most soundfont will be used.
    -
    +
    -
    +
    Plugin manager. View details of plugins, enable or disable them here.
    Enabled plugin list is applied after a restart.
    Plugin scanning follows the order below: diff --git a/doc/plistdialog.html b/doc/plistdialog.html index 40ef542..3dafcc2 100644 --- a/doc/plistdialog.html +++ b/doc/plistdialog.html @@ -24,7 +24,7 @@

    Playlist Dialog

    -
    +

    Notes

    diff --git a/doc/version.html b/doc/version.html index d3b3218..790cedf 100644 --- a/doc/version.html +++ b/doc/version.html @@ -26,7 +26,7 @@

    Version information


    - QMidiPlayer documentation for version 0.8.5
    + QMidiPlayer documentation for version 0.8.7
    An MIDI player based on fluidsynth and Qt.
    Written by Chris Xiong.

    diff --git a/doc/visualization.html b/doc/visualization.html index f482744..3507985 100644 --- a/doc/visualization.html +++ b/doc/visualization.html @@ -42,11 +42,6 @@ left | right ← → │ │ | Seek left/right └─────┘ backward (Hold shift to seek 5% instead of 1%) -

    Known problems

    -

    - In some systems closing and reopening the visualization results in a crash. This is - due to a dbus-related conflict in SDL and Qt. -

    Options

    The options listed here are applied after closing and reopening the visualization.