Members of the KDE Community are recommended to subscribe to the kde-community mailing list at https://mail.kde.org/mailman/listinfo/kde-community to allow them to participate in important discussions and receive other important announcements

Commit 138ca26e authored by Yuri Chornoivan's avatar Yuri Chornoivan

Fix minor EBN issues and typos

parent 5a2486a4
......@@ -111,7 +111,7 @@
To add KIPI support to your application you must inherit
KIPI::Interface, and give an instance of this class to
KIPI::PluginLoader. See \ref KIPI::PluginLoader for details on loading plugins.
KIPI::PluginLoader. See \ref PluginLoader "KIPI::PluginLoader" for details on loading plugins.
To be able to create an instance of your subclass of KIPI::Interface,
you must of course implement all the pure virtual method of the super
......
......@@ -87,8 +87,8 @@ public:
Q_SIGNALS:
/** Signal emitted when filetring is done through slotSetFilter().
* Number of plugins found is sent when item relevant of filetring match the query.
/** Signal emitted when filtering is done through slotSetFilter().
* Number of plugins found is sent when item relevant of filtering match the query.
*/
void signalSearchResult(int);
......
......@@ -113,9 +113,8 @@ public:
* The function may choose to return the directory for the image collection
* or if images from the collection are not available in a common directory,
* then instead a common upload directory.
* In contrast to \ref path, this function must return a valid url.
*
* IMPORTANT: uploadRoot() must be a subpath of uploadPath()
* IMPORTANT: uploadRootUrl() must be a subpath of uploadUrl()
*/
QUrl uploadUrl() const;
......@@ -124,21 +123,21 @@ public:
* which gives the user the possible to show a directory from a tree view.
*
* This tree view widget needs to starts at some URL. This function specifies that location.
* Here are a couble of possible return value different host applications may choose.
* Here are a couple of possible return value different host applications may choose.
*
* If all images are stored rooted at some tree (which is the case for KPhotoAlbum),
* then this function may return this directory unconditionally.
* The root directory returned by uploadPath() (which is the default implementation for this method)
* will be the directory returned by uploadPath().
* The root directory returned by uploadUrl() (which is the default implementation for this method)
* will be the directory returned by uploadUrl().
*
* IMPORTANT: uploadRoot() must be a subpath of uploadPath()
* IMPORTANT: uploadRootUrl() must be a subpath of uploadUrl()
*/
QUrl uploadRootUrl() const;
/**
* This fonction return the name of the upload root path used by the
* This function return the name of the upload root path used by the
* the KIPI::UploadWidget. This name can be different for each host
* app (like "Images" for Kphotoalbum).
* app (like "Images" for KPhotoAlbum).
*/
QString uploadRootName() const;
......
......@@ -131,7 +131,7 @@ public:
</tr><tr>
<th>"tagspath"</th>
<td>QStringList</td>
<td>Return all tags path list of item, formated as "Country/France/City/Paris" for ex.</td>
<td>Return all tags path list of item, formatted as "Country/France/City/Paris" for ex.</td>
</tr><tr>
<th>"keywords"</th>
<td>QStringList</td>
......
......@@ -76,8 +76,8 @@ enum Features
ImagesHasComments = 1 << 1, /** This feature specifies that images in the host application has descriptions associated to them. */
ImagesHasTime = 1 << 2, /** This feature specifies that images has a date associated with it, which the host application can display and set. */
HostSupportsDateRanges = 1 << 3, /** This feature specifies whether the host application supports that the user can specify a date range for images, like 1998-2000. */
HostAcceptNewImages = 1 << 4, /** This feature specifies that the host application do accept new images. Use \ref ImageCollection::uploadPath to find the
location to place the image, and \ref KIPI::Interface::addImage() to tell the host application about the new image. */
HostAcceptNewImages = 1 << 4, /** This feature specifies that the host application do accept new images. Use \ref ImageCollection::uploadUrl to find the
location to place the image, and \ref Interface::addImage() to tell the host application about the new image. */
ImagesHasTitlesWritable = 1 << 5, /** This feature specifies whether the plugin can change the title for images. */
CollectionsHaveCategory = 1 << 6, /** This feature specifies that collections are category associated to them ('travels', 'friends', 'monuments', etc.). */
CollectionsHaveCreationDate = 1 << 7, /** This feature specifies that collections are a creation date associated to them. */
......@@ -314,7 +314,7 @@ public:
virtual void refreshImages(const QList<QUrl>&);
/**
* Tells to host application to render imediatly a preview image for one item.
* Tells to host application to render immediatly a preview image for one item.
* This method re-implemented in host application and be thread safe.
*/
virtual QImage preview(const QUrl& url);
......@@ -322,7 +322,7 @@ public:
/**
* Tell to host application to save image at url in specific format (JPG, PNG, TIF, etc).
* Pixels image data must be in ARGB, with image size (width,height).
* Pixels can be in siwteen bits per color per pixels and can have an alpha chanel.
* Pixels can be in sixteen bits per color per pixels and can have an alpha channel.
* If cancel flag is passed it permit to cancel save operation.
* This method re-implemented in host application must be thread safe.
*/
......@@ -333,7 +333,7 @@ public:
/**
* Tells to host application to render a preview image for one item.
* A resizement to to a specific size will be generated if preview is largest than.
* A resizement to a specific size will be generated if preview is largest than.
* Use a positive resizedTo value in this case, else -1. Aspect ratio is preserved while rendering.
* This asynchronous method must be re-implemented in host application.
* Use gotPreview() signal to take preview.
......@@ -475,7 +475,7 @@ Q_SIGNALS:
*/
void gotThumbnail(const QUrl&, const QPixmap&);
/** Emit when host application has rendered item preview image. See assynchronous preview() methods for details.
/** Emit when host application has rendered item preview image. See asynchronous preview() methods for details.
*/
void gotPreview(const QUrl&, const QImage&);
......
......@@ -112,7 +112,7 @@ public:
Interface* interface() const;
/**
* Virtual method that must be overrided by the non abstract descendants and
* Virtual method that must be overridden by the non abstract descendants and
* must be called before any actions are added.
*
* @param widget The widget which holds the plugin. It will be set as the default widget.
......
......@@ -268,7 +268,7 @@ public:
/**
* Init plugin loader. Call this method to parse relevant plugins installed on your system.
* Before to call this method, you must setup KIPI insterface instance.
* Before to call this method, you must setup KIPI interface instance.
* Optionally, setup list of plugins to ignore, the constraint list, and
* the disabled plugin actions
*/
......@@ -305,7 +305,7 @@ Q_SIGNALS:
void plug(KIPI::PluginLoader::Info*);
void unplug(KIPI::PluginLoader::Info*);
// NOTE: plugin can be pluged through Info item.
// NOTE: plugin can be plugged through Info item.
void replug();
private:
......
......@@ -324,7 +324,7 @@ int main(int argc, char* argv[])
parser.addOption(QCommandLineOption(QStringList() << QLatin1String("l"), QLatin1String("Library name of plugin to use"), QLatin1String("library")));
parser.addOption(QCommandLineOption(QStringList() << QLatin1String("a"), QLatin1String("Action to call"), QLatin1String("action")));
parser.addOption(QCommandLineOption(QStringList() << QLatin1String("i"), QLatin1String("Selected images"), QLatin1String("selectedimages")));
parser.addOption(QCommandLineOption(QStringList() << QLatin1String("c"), QLatin1String("Selected colections"), QLatin1String("selectedcollections")));
parser.addOption(QCommandLineOption(QStringList() << QLatin1String("c"), QLatin1String("Selected collections"), QLatin1String("selectedcollections")));
parser.addOption(QCommandLineOption(QStringList() << QLatin1String("allc"), QLatin1String("All collections"), QLatin1String("allcollections")));
parser.addOption(QCommandLineOption(QStringList() << QLatin1String("+[images]"), QLatin1String("List of images")));
parser.addOption(QCommandLineOption(QStringList() << QLatin1String("+[collections]"), QLatin1String("List of collections")));
......@@ -449,7 +449,7 @@ int main(int argc, char* argv[])
{
qCritical() << "No argument specified: either use --list,\n"
"or specify an action to be called.\n"
"Exemple : ./kipicmd -w -lkipiplugin_kxmlhelloworld -a\"KXML Hello World Image...\" -i ~/Images/*";
"Example : ./kipicmd -w -lkipiplugin_kxmlhelloworld -a\"KXML Hello World Image...\" -i ~/Images/*";
return 0;
}
......
......@@ -306,7 +306,7 @@ QString KipiTestPluginLoader::categoryShortName(Category cat) const
break;
case CollectionsPlugin:
res = QLatin1String("Collenctions");
res = QLatin1String("Collections");
break;
default:
......
......@@ -74,7 +74,7 @@ namespace KIPIKXMLHelloWorldPlugin
{
/** Under Kipi-plugins, you can use KPToolDialog class from kipi-plugins to display plugin dialogs. It offers some facilities to
set data and rules about plugins, especially to wrap properlly tool with KDE bugilla. We use KPAboutData container
set data and rules about plugins, especially to wrap properly tool with KDE bugzilla. We use KPAboutData container
for that.
*/
......@@ -95,7 +95,7 @@ public:
actionImport = 0;
}
/** These plugin actions will pluged into menu KIPI host application.
/** These plugin actions will plugged into menu KIPI host application.
*/
QAction* actionImages;
QAction* actionTools;
......@@ -110,7 +110,7 @@ public:
*/
K_PLUGIN_FACTORY(KXMLHelloWorldFactory, registerPlugin<Plugin_KXMLHelloWorld>();)
/** The plugin constructor. Note that plugin name passed as string in 3rd arguement of KIPI::Plugin parent class
/** The plugin constructor. Note that plugin name passed as string in 3rd argument of KIPI::Plugin parent class
* is the same than Name value from .desktop file.
*/
Plugin_KXMLHelloWorld::Plugin_KXMLHelloWorld(QObject* const parent, const QVariantList&)
......@@ -167,7 +167,7 @@ void Plugin_KXMLHelloWorld::setupActions()
* about already existing one from other tool to prevent conflict.
* Don't forget to define an unique string name to your action, to be able to disable it
* in KIPI host application if necessary. You must check of course name already used in
* others tool before to prevent redondancy.
* others tool before to prevent redundancy.
*/
/** We need to call setDefaultCategory in case the plugin loader cannot
......
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