From 91324fa520e4a1a84b67e5c1dd420079755871ee Mon Sep 17 00:00:00 2001 From: Ghislain MARY Date: Wed, 30 Nov 2016 11:06:04 +0100 Subject: [PATCH] Use common syntax for linphone-daemon commands documentation. --- daemon/commands/adaptive-jitter-compensation.cc | 7 +++---- daemon/commands/answer.cc | 2 +- daemon/commands/audio-codec-get.cc | 2 +- daemon/commands/audio-codec-move.cc | 2 +- daemon/commands/audio-codec-set.cc | 2 +- daemon/commands/audio-codec-toggle.cc | 6 +++--- daemon/commands/audio-stream-start.cc | 2 +- daemon/commands/audio-stream-stats.cc | 2 +- daemon/commands/audio-stream-stop.cc | 2 +- daemon/commands/auth-infos-clear.cc | 2 +- daemon/commands/call-mute.cc | 2 +- daemon/commands/call-pause.cc | 2 +- daemon/commands/call-resume.cc | 2 +- daemon/commands/call-stats.cc | 2 +- daemon/commands/call-status.cc | 2 +- daemon/commands/call-transfer.cc | 2 +- daemon/commands/call.cc | 2 +- daemon/commands/conference.cc | 8 ++++---- daemon/commands/config.cc | 6 +++--- daemon/commands/contact.cc | 2 +- daemon/commands/dtmf.cc | 2 +- daemon/commands/firewall-policy.cc | 3 +-- daemon/commands/help.cc | 2 +- daemon/commands/jitterbuffer.cc | 8 ++++---- daemon/commands/msfilter-add-fmtp.cc | 2 +- daemon/commands/netsim.cc | 2 +- daemon/commands/port.cc | 5 ++--- daemon/commands/ptime.cc | 2 +- daemon/commands/register-status.cc | 2 +- daemon/commands/register.cc | 8 ++++---- daemon/commands/terminate.cc | 2 +- daemon/commands/unregister.cc | 2 +- daemon/commands/video.cc | 12 ++++++------ 33 files changed, 54 insertions(+), 57 deletions(-) diff --git a/daemon/commands/adaptive-jitter-compensation.cc b/daemon/commands/adaptive-jitter-compensation.cc index 313de6ee4..7bc8670d4 100644 --- a/daemon/commands/adaptive-jitter-compensation.cc +++ b/daemon/commands/adaptive-jitter-compensation.cc @@ -67,10 +67,9 @@ void AdaptiveBufferCompensationResponse::outputAdaptiveBufferCompensation(Linpho } AdaptiveBufferCompensationCommand::AdaptiveBufferCompensationCommand() : - DaemonCommand("adaptive-jitter-compensation", "adaptive-jitter-compensation [] [enable|disable]", - "Enable or disable adaptive buffer compensation respectively with the 'enable' and 'disable' parameters for the specified stream, " - "return the status of the use of adaptive buffer compensation without parameter.\n" - " must be one of these values: audio, video.") { + DaemonCommand("adaptive-jitter-compensation", "adaptive-jitter-compensation [audio|video] [enable|disable]", + "Enable or disable adaptive buffer compensation respectively with the 'enable' and 'disable' parameters for the specified stream, " + "return the status of the use of adaptive buffer compensation without parameter.") { addExample(new DaemonCommandExample("adaptive-jitter-compensation audio", "Status: Ok\n\n" "Audio: enabled")); diff --git a/daemon/commands/answer.cc b/daemon/commands/answer.cc index 2c347fd0d..f14b9dcbe 100644 --- a/daemon/commands/answer.cc +++ b/daemon/commands/answer.cc @@ -22,7 +22,7 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA using namespace std; AnswerCommand::AnswerCommand() : - DaemonCommand("answer", "answer ", "Answer an incoming call.") { + DaemonCommand("answer", "answer ", "Answer an incoming call.") { addExample(new DaemonCommandExample("answer 3", "Status: Error\n" "Reason: No call with such id.")); diff --git a/daemon/commands/audio-codec-get.cc b/daemon/commands/audio-codec-get.cc index c529c8789..7fc11b007 100644 --- a/daemon/commands/audio-codec-get.cc +++ b/daemon/commands/audio-codec-get.cc @@ -22,7 +22,7 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA using namespace std; AudioCodecGetCommand::AudioCodecGetCommand() : - DaemonCommand("audio-codec-get", "audio-codec-get ", + DaemonCommand("audio-codec-get", "audio-codec-get |", "Get an audio codec if a parameter is given, otherwise return the audio codec list.\n" " is of the form mime/rate/channels, eg. speex/16000/1") { addExample(new DaemonCommandExample("audio-codec-get 9", diff --git a/daemon/commands/audio-codec-move.cc b/daemon/commands/audio-codec-move.cc index be2f955e2..4ef301fea 100644 --- a/daemon/commands/audio-codec-move.cc +++ b/daemon/commands/audio-codec-move.cc @@ -22,7 +22,7 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA using namespace std; AudioCodecMoveCommand::AudioCodecMoveCommand() : - DaemonCommand("audio-codec-move", "audio-codec-move ", + DaemonCommand("audio-codec-move", "audio-codec-move | ", "Move a codec to the specified index.\n" " is of the form mime/rate/channels, eg. speex/16000/1") { addExample(new DaemonCommandExample("audio-codec-move 9 1", diff --git a/daemon/commands/audio-codec-set.cc b/daemon/commands/audio-codec-set.cc index 65cd09032..dd446a9ac 100644 --- a/daemon/commands/audio-codec-set.cc +++ b/daemon/commands/audio-codec-set.cc @@ -28,7 +28,7 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA using namespace std; AudioCodecSetCommand::AudioCodecSetCommand() : - DaemonCommand("audio-codec-set", "audio-codec-set ", + DaemonCommand("audio-codec-set", "audio-codec-set | ", "Set a property (number, clock_rate, recv_fmtp, send_fmtp, bitrate (in kbps/s)) of a codec. Numbering of payload type is automatically performed at startup, any change will be lost after restart.\n" " is of the form mime/rate/channels, eg. speex/16000/1") { addExample(new DaemonCommandExample("audio-codec-set 9 number 18", diff --git a/daemon/commands/audio-codec-toggle.cc b/daemon/commands/audio-codec-toggle.cc index 57deeb882..930387d6f 100644 --- a/daemon/commands/audio-codec-toggle.cc +++ b/daemon/commands/audio-codec-toggle.cc @@ -66,7 +66,7 @@ void AudioCodecToggleCommand::exec(Daemon *app, const string& args) { } AudioCodecEnableCommand::AudioCodecEnableCommand() : - AudioCodecToggleCommand("audio-codec-enable", "audio-codec-enable ", + AudioCodecToggleCommand("audio-codec-enable", "audio-codec-enable ||ALL", "Enable an audio codec.\n" " is of the form mime/rate/channels, eg. speex/16000/1", true) { addExample(new DaemonCommandExample("audio-codec-enable G722/8000/1", @@ -94,7 +94,7 @@ AudioCodecEnableCommand::AudioCodecEnableCommand() : } AudioCodecDisableCommand::AudioCodecDisableCommand() : - AudioCodecToggleCommand("audio-codec-disable", "audio-codec-disable ", + AudioCodecToggleCommand("audio-codec-disable", "audio-codec-disable ||ALL", "Disable an audio codec.\n" " is of the form mime/rate/channels, eg. speex/16000/1", false) { addExample(new DaemonCommandExample("audio-codec-disable G722/8000/1", @@ -119,4 +119,4 @@ AudioCodecDisableCommand::AudioCodecDisableCommand() : "Recv-fmtp: \n" "Send-fmtp: \n" "Enabled: false")); -} \ No newline at end of file +} diff --git a/daemon/commands/audio-stream-start.cc b/daemon/commands/audio-stream-start.cc index 3e85cc391..6771bfced 100644 --- a/daemon/commands/audio-stream-start.cc +++ b/daemon/commands/audio-stream-start.cc @@ -23,7 +23,7 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA using namespace std; AudioStreamStartCommand::AudioStreamStartCommand() : - DaemonCommand("audio-stream-start", "audio-stream-start ", "Start an audio stream.") { + DaemonCommand("audio-stream-start", "audio-stream-start ", "Start an audio stream.") { addExample(new DaemonCommandExample("audio-stream-start 192.168.1.28 7078 9", "Status: Ok\n\n" "Id: 1")); diff --git a/daemon/commands/audio-stream-stats.cc b/daemon/commands/audio-stream-stats.cc index ca663e5d4..4845dbb7b 100644 --- a/daemon/commands/audio-stream-stats.cc +++ b/daemon/commands/audio-stream-stats.cc @@ -22,7 +22,7 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA using namespace std; AudioStreamStatsCommand::AudioStreamStatsCommand() : - DaemonCommand("audio-stream-stats", "audio-stream-stats ", "Return stats of a given audio stream.") { + DaemonCommand("audio-stream-stats", "audio-stream-stats ", "Return stats of a given audio stream.") { addExample(new DaemonCommandExample("audio-stream-stats 1", "Status: Ok\n\n" "Audio-ICE state: Not activated\n" diff --git a/daemon/commands/audio-stream-stop.cc b/daemon/commands/audio-stream-stop.cc index 2ef0d7559..fdb0208df 100644 --- a/daemon/commands/audio-stream-stop.cc +++ b/daemon/commands/audio-stream-stop.cc @@ -22,7 +22,7 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA using namespace std; AudioStreamStopCommand::AudioStreamStopCommand() : - DaemonCommand("audio-stream-stop", "audio-stream-stop