]> git.sesse.net Git - casparcg/commitdiff
Merge pull request #450 from SuperFlyTV/feature/documentation
authorHellGore <helge.norberg@gmail.com>
Mon, 11 Jul 2016 15:36:23 +0000 (17:36 +0200)
committerGitHub <noreply@github.com>
Mon, 11 Jul 2016 15:36:23 +0000 (17:36 +0200)
Documentation corrections. Solves #437.

protocol/amcp/AMCPCommandsImpl.cpp

index d4f311f5a50a66174ca9a911bfcf76b5916ac189..710977ec666156b916071f7e65ccd74a8f44b4ad 100644 (file)
@@ -818,7 +818,7 @@ std::wstring data_store_command(command_context& ctx)
 void data_retrieve_describer(core::help_sink& sink, const core::help_repository& repo)
 {
        sink.short_description(L"Retrieve a dataset.");
-       sink.syntax(L"DATA RETRIEVE [name:string] [data:string]");
+       sink.syntax(L"DATA RETRIEVE [name:string]");
        sink.para()->text(L"Returns the data saved under the name ")->code(L"name")->text(L".");
        sink.para()->text(L"Examples:");
        sink.example(L">> DATA RETRIEVE my_data");
@@ -2300,6 +2300,14 @@ void version_describer(core::help_sink& sink, const core::help_repository& repo)
                L">> VERSION FLASH\n"
                L"<< 201 VERSION OK\n"
                L"<< 11.8.800.94");
+       sink.example(
+               L">> VERSION TEMPLATEHOST\n"
+               L"<< 201 VERSION OK\n"
+               L"<< unknown");
+       sink.example(
+               L">> VERSION CEF\n"
+               L"<< 201 VERSION OK\n"
+               L"<< 3.1750.1805");
 }
 
 std::wstring version_command(command_context& ctx)