Commit 747f4ba9 authored by Martin Schultz's avatar Martin Schultz

improved visibility of signal parameters in documentation for

PluginConnectionInterface
parent 5c6d2df3
......@@ -80,24 +80,24 @@ class PluginConnectionInterface {
/** \brief connect signals and slots of plugins across plugins
*
* Connect a signal of one plugin to another plugin by its scripting name.
* _pluginName1 is the scripting name of the plugin containing the signal ( Use script editor to check that name)
* _signal is the signal name. Use it like with regular connect ( <tt>SIGNAL(...)</tt> ) macro
* _pluginName2 is the scripting name of the plugin containing a slot
* _slot is the slot name. Use it like with regular connect ( <tt>SLOT(...)</tt> ) macro
* \param _pluginName1 is the scripting name of the plugin containing the signal ( Use script editor to check that name)
* \param _signal is the signal name. Use it like with regular connect ( <tt>SIGNAL(...)</tt> ) macro
* \param _pluginName2 is the scripting name of the plugin containing a slot
* \param _slot is the slot name. Use it like with regular connect ( <tt>SLOT(...)</tt> ) macro
*
*/
virtual void crossPluginConnect( QString /*_pluginName1*/, const char* /*_signal*/, QString /*_pluginName2*/, const char* /*_slot*/) = 0;
virtual void crossPluginConnect( QString _pluginName1, const char* _signal, QString _pluginName2, const char* _slot) = 0;
/** \brief connect signals and slots of plugins across plugins using Qt::QueuedConnection
*
* Connect a signal of one plugin to another plugin by its scripting name.
* _pluginName1 is the scripting name of the plugin containing the signal ( Use script editor to check that name)
* _signal is the signal name. Use it like with regular connect ( <tt>SIGNAL(...)</tt> ) macro
* _pluginName2 is the scripting name of the plugin containing a slot
* _slot is the slot name. Use it like with regular connect ( <tt>SLOT(...)</tt> ) macro
* \param _pluginName1 is the scripting name of the plugin containing the signal ( Use script editor to check that name)
* \param _signal is the signal name. Use it like with regular connect ( <tt>SIGNAL(...)</tt> ) macro
* \param _pluginName2 is the scripting name of the plugin containing a slot
* \param _slot is the slot name. Use it like with regular connect ( <tt>SLOT(...)</tt> ) macro
*
*/
virtual void crossPluginConnectQueued( QString /*_pluginName1*/, const char* /*_signal*/, QString /*_pluginName2*/, const char* /*_slot*/) = 0;
virtual void crossPluginConnectQueued( QString _pluginName1, const char* _signal, QString _pluginName2, const char* _slot) = 0;
public :
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment