Logo Search packages:      
Sourcecode: henplus version File versions  Download package

String henplus::Command::getSynopsis ( String  cmd  ) 

retuns a synopsis-string. The synopsis string returned should follow the following conventions:

  • expected parameters are described with angle brackets like in export-xml <table> <filename>
  • optional parameters are described with square brackets like in help [command]

Should contain no newline, no leading spaces. This synopsis is printed in the detailed help of a command or if the execute()-method returned a SYNTAX_ERROR.

Parameters:
cmd the command the synopsis is for. This is one of the possible commands returned by getCommandList().

Implemented in henplus::AbstractCommand, henplus::commands::AliasCommand, henplus::commands::ConnectCommand, henplus::commands::DescribeCommand, henplus::commands::DriverCommand, henplus::commands::DumpCommand, henplus::commands::EchoCommand, henplus::commands::ExitCommand, henplus::commands::ExportCommand, henplus::commands::HelpCommand, henplus::commands::ListUserObjectsCommand, henplus::commands::LoadCommand, henplus::commands::PluginCommand, henplus::commands::properties::AbstractPropertyCommand, henplus::commands::SetCommand, henplus::commands::ShellCommand, henplus::commands::SpoolCommand, henplus::commands::SQLCommand, henplus::commands::TreeCommand, and henplus::SamplePlugin.

Referenced by henplus::commands::HelpCommand::execute(), and henplus::CommandDispatcher::execute().


Generated by  Doxygen 1.6.0   Back to index