D9079: bluedevil-sendfile: Set option descriptions for command line help

[Jonathan Marten]

marten created this revision.
marten added a reviewer: Plasma.
Restricted Application added a project: Plasma.
Restricted Application added a subscriber: plasma-devel.

REVISION SUMMARY
  The "--kio", "--ubi" and "--files"options (or their short equivalents) have no description text set.  This does not affect their functionality, but the options are not displayed correctly if the "--help" option is used:
  
    $ bluedevil-sendfile --help
    Usage: bluedevil-sendfile [options]
    Bluetooth Send File Wizard
    
    Options:
      --kio, -k <bluetooth://address>    --ubi, -u <ubi>                    --files, -f <files>                -h, --help                       Displays this help.
      -v, --version                    Displays version information.
      --author                         Show author information.
      --license                        Show licence information.
      --desktopfile <file name>        The base file name of the desktop entry for
                                       this application.
  
  Setting a description for these options displays the help correctly:
  
    $ bluedevil-sendfile --help
    Usage: bluedevil-sendfile [options]
    Bluetooth Send File Wizard
    
    Options:
      --kio, -k <bluetooth://address>  Specify receiving device by MAC address.
      --ubi, -u <ubi>                  Specify receiving device by UBI path.
      --files, -f <files>              Files to be sent.
      -h, --help                       Displays this help.
      -v, --version                    Displays version information.
      --author                         Show author information.
      --license                        Show licence information.
      --desktopfile <file name>        The base file name of the desktop entry for
                                       this application.
  
  This is really a problem with QCommandLineParser or something associated with it, but in the interests of good documentation there should be a description for the options anyway.

TEST PLAN
  Built bluedevil-sendfile with these changes, observed correct "--help" output as above.

REPOSITORY
  R97 Bluedevil

REVISION DETAIL
  https://phabricator.kde.org/D9079

AFFECTED FILES
  src/sendfile/main.cpp

To: marten, #plasma
Cc: plasma-devel, ZrenBot, progwolff, lesliezhai, ali-mohamed, jensreuterberg, abetts, sebas, apol, mart
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/plasma-devel/attachments/20171201/3054b6e3/attachment-0001.html>