Merge pull request #1035 from luzpaz/typos/Libs

DOC: Fix typos in the Libs/ subdirectory

Libs/CommandLineModules/Backend/LocalProcess/ctkCmdLineModuleBackendLocalProcess.h

@@ -46,7 +46,7 @@ struct ctkCmdLineModuleBackendLocalProcessPrivate;
  * The XML description for a module is extracted from the standard output of the
  * executable when calling it with the \c ––xml command line argument.
  *
- * The ctkCmdLineModuleFuture returned by run() allows cancelation by killing the running
+ * The ctkCmdLineModuleFuture returned by run() allows cancellation by killing the running
  * process. On Unix systems, it also allows to pause it.
  */
 class CTK_CMDLINEMODULEBACKENDLP_EXPORT ctkCmdLineModuleBackendLocalProcess : public ctkCmdLineModuleBackend

Libs/CommandLineModules/Core/Resources/ctkCmdLineModule.xsd

@@ -338,7 +338,7 @@
   <xsd:complexType name="enumerationType">
     <xsd:annotation>
       <xsd:documentation>Restricts the valid parameter value to one and only one element out of
-      a specified descrete set of values.</xsd:documentation>
+      a specified discrete set of values.</xsd:documentation>
     </xsd:annotation>
     <xsd:complexContent>
       <xsd:extension base="paramType">

Libs/CommandLineModules/Core/Testing/Cpp/ctkCmdLineModuleDefaultPathBuilderTest.cpp

@@ -141,7 +141,7 @@ int ctkCmdLineModuleDefaultPathBuilderTest(int argc, char* argv[])
     {
       if (!loadPaths.contains(path))
       {
-        qDebug() << "Expecte loadPaths to contain path=" << path;
+        qDebug() << "Expected loadPaths to contain path=" << path;
         return EXIT_FAILURE;
       }
     }

Libs/CommandLineModules/Core/ctkCmdLineModuleBackend.h

@@ -68,7 +68,7 @@ struct CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleBackend
   virtual QList<QString> schemes() const = 0;
 
   /**
-   * @brief Returns a timestap of the backend, which for example in the
+   * @brief Returns a timestamp of the backend, which for example in the
    * case of the LocalProcess may be the last modified time of the command line
    * application.
    */
@@ -86,7 +86,7 @@ struct CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleBackend
    * return value of timeStamp().
    *
    * Implementations should also throw either a ctkCmdLineModuleTimeoutException
-   * object if a time-out occured when retrieving the XML parameter description
+   * object if a time-out occurred when retrieving the XML parameter description
    * or a ctkCmdLineModuleRunException for any other error during invocation
    * of the module.
    *

Libs/CommandLineModules/Core/ctkCmdLineModuleFrontend.h

@@ -104,7 +104,7 @@ class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleFrontend : public QObject
 
   /**
    * @brief Returns the GUI representation.
-   * @return A GUI handle that can then be embeded in an application window for instance.
+   * @return A GUI handle that can then be embedded in an application window for instance.
    *
    * The returned object is a handle to the real GUI toolkit specific object representing
    * the user interface. For Qt based front-ends, the returned object is usually a QWidget
@@ -140,7 +140,7 @@ class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleFrontend : public QObject
    * provide asynchronous processing and interaction with the running frontend.
    *
    * Note that the future returned by this method will be different after the
-   * frontend was started. Either use isRunning() to check wether this frontend
+   * frontend was started. Either use isRunning() to check whether this frontend
    * is currently running or connect to the started() signal.
    *
    * @see ctkCmdLineModuleFuture

Libs/CommandLineModules/Core/ctkCmdLineModuleFutureWatcher.h

@@ -91,7 +91,7 @@ class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleFutureWatcher : public QFutur
   const ctkCmdLineModuleFutureInterface& futureInterface() const;
   ctkCmdLineModuleFutureInterface& futureInterface();
 
-  // not imlemented
+  // not implemented
   void setFuture(const QFuture<ctkCmdLineModuleResult>&);
 };
 

Libs/CommandLineModules/Core/ctkCmdLineModuleManager.cpp

@@ -140,7 +140,7 @@ void ctkCmdLineModuleManager::registerBackend(ctkCmdLineModuleBackend *backend)
 
   QList<QString> supportedSchemes = backend->schemes();
 
-  // Check if there is already a backend registerd for any of the
+  // Check if there is already a backend registered for any of the
   // supported schemes. We only supported one backend per scheme.
   foreach (QString scheme, supportedSchemes)
   {

Libs/CommandLineModules/Core/ctkCmdLineModuleManager.h

@@ -154,7 +154,7 @@ class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleManager : public QObject
    * @return A module reference.
    * @throws ctkInvalidArgumentException if no back-end for the given URL scheme was registered
    *         or the XML description for the module is invalid.
-   * @throws ctkCmdLineModuleTimeoutException if a time-out occured when retrieving the
+   * @throws ctkCmdLineModuleTimeoutException if a time-out occurred when retrieving the
    *         XML description from the module.
    * @throws ctkCmdLineModuleRunException if a general error occurred when running the module.
    */

Libs/CommandLineModules/Core/ctkCmdLineModuleParameter.h

@@ -113,7 +113,7 @@ class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleParameter
   QString deprecatedLongFlagAliasesAsString() const;
 
   /**
-   * @return A (possibly empty) list of deprectated long flag aliases.
+   * @return A (possibly empty) list of deprecated long flag aliases.
    */
   QStringList deprecatedLongFlagAliases() const;
 

Libs/CommandLineModules/Core/ctkCmdLineModuleXmlProgressWatcher.cpp

@@ -47,14 +47,14 @@ class ctkCmdLineModuleXmlProgressWatcherPrivate
   ctkCmdLineModuleXmlProgressWatcherPrivate(QIODevice* input, ctkCmdLineModuleXmlProgressWatcher* qq)
     : input(input), process(NULL), readPos(0), q(qq), error(false), currentProgress(0)
   {
-    // wrap the content in an artifical root element
+    // wrap the content in an artificial root element
     reader.addData("<module-root>");
   }
 
   ctkCmdLineModuleXmlProgressWatcherPrivate(QProcess* input, ctkCmdLineModuleXmlProgressWatcher* qq)
     : input(input), process(input), readPos(0), q(qq), error(false), currentProgress(0)
   {
-    // wrap the content in an artifical root element
+    // wrap the content in an artificial root element
     reader.addData("<module-root>");
   }
 

Libs/CommandLineModules/Core/ctkCmdLineModuleXmlProgressWatcher.h

@@ -36,7 +36,7 @@ class QProcess;
  * \brief Provides progress updates of a module.
  * \ingroup CommandLineModulesCore_API
  *
- * This class is usually only used by back-end implementators for modules
+ * This class is usually only used by back-end implementers for modules
  * which can report progress and results in the form of XML fragments written
  * to a QIODevice.
  */

Libs/CommandLineModules/Core/ctkCmdLineModuleXmlValidator.h

@@ -70,7 +70,7 @@ class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleXmlValidator
 
   /**
    * @brief Get the error flag.
-   * @return \c true if an error occured during validation, \c false otherwise.
+   * @return \c true if an error occurred during validation, \c false otherwise.
    */
   virtual bool error() const;
 

Libs/CommandLineModules/Core/ctkCmdLineModuleXslTransform.h

@@ -73,7 +73,7 @@ class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleXslTransform
 
   /**
    * @brief Returns \c true if the XSL output will be formatted.
-   * @return \c true if the ouptut will be formatted, \c false otherwise.
+   * @return \c true if the output will be formatted, \c false otherwise.
    */
   bool formatXmlOutput() const;
 
@@ -144,9 +144,9 @@ class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleXslTransform
   bool validateOutput() const;
 
   /**
-   * @brief Returns true if an error occured.
+   * @brief Returns true if an error occurred.
    *
-   * transform() sets the error flag if an error occured when transforming the
+   * transform() sets the error flag if an error occurred when transforming the
    * XML file into XSL or validating the transformation.
    *
    * @sa errorString
@@ -156,7 +156,7 @@ class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleXslTransform
   /**
    * @brief Returns the error message if any.
    *
-   * transform() sets the error message if an error occured when transforming
+   * transform() sets the error message if an error occurred when transforming
    * the XML file into XSL.
    *
    * @sa error

Libs/CommandLineModules/Frontend/QtGui/ctkCmdLineModuleFrontendQtGui.h

@@ -191,7 +191,7 @@ class CTK_CMDLINEMODULEQTGUI_EXPORT ctkCmdLineModuleFrontendQtGui : public ctkCm
   virtual QUiLoader* uiLoader() const;
 
   /**
-   * @brief Get XSL transform used to transfrom the module XML description to a Qt .ui file.
+   * @brief Get XSL transform used to transform the module XML description to a Qt .ui file.
    * @return The XSL transform.
    *
    * Override this method to either customize the default transformation or completely provide

Libs/CommandLineModules/README.md

@@ -66,7 +66,7 @@ The valid XML structure for the parameter description is defined in the correspo
 ([absolute link](http://commontk.org/docs/html/ctkCmdLineModule.xsd)).
 
 Please note that running a module may fail due to an invalid XML description. The strictness of validation is specific to the
-application you are using to run the module. However, making sure the XML validates agains the given schema (raw schema file
+application you are using to run the module. However, making sure the XML validates against the given schema (raw schema file
 [here](https://raw.github.com/commontk/CTK/master/Libs/CommandLineModules/Core/Resources/ctkCmdLineModule.xsd)).
 
 ### Progress and Result reporting
@@ -112,7 +112,7 @@ the module XML description for a specific module.
 The central class for managing modules is the ctkCmdLineModuleManager. There must be at least one back-end registered
 with the manager for module registrations to succeed. A module is registered by calling the
 ctkCmdLineModuleManager::registerModule(const QUrl&) method, providing the URL to the module. If the URL scheme is not handled
-by a previously registerd back-end, an exception is thrown. If registration succeeds, the method returns a
+by a previously registered back-end, an exception is thrown. If registration succeeds, the method returns a
 ctkCmdLineModuleReference object.
 
 Creating specific front-ends for a given module is actually independent of the ctkCmdLineModuleManager, except that a
@@ -121,7 +121,7 @@ ctkCmdLineModuleFrontendFactory::create(const ctkCmdLineModuleReference&) method
 ctkCmdLineModuleFrontend pointer.
 
 This separation of concerns in front and back ends allows for an extensible and flexible design. Front-ends and back-ends
-work independent of each other and can be combined arbitrarly.
+work independent of each other and can be combined arbitrarily.
 
 
 Quick Start

Libs/CommandLineModules/Testing/Cpp/ctkCmdLineModuleFutureTest.cpp

@@ -458,7 +458,7 @@ void ctkCmdLineModuleFutureTester::testError()
 {
   frontend->setValue("fileVar", "output1");
   frontend->setValue("exitCodeVar", 24);
-  frontend->setValue("errorTextVar", "Some error occured\n");
+  frontend->setValue("errorTextVar", "Some error occurred\n");
 
   ctkCmdLineModuleFuture future = manager.run(frontend);
 
@@ -470,7 +470,7 @@ void ctkCmdLineModuleFutureTester::testError()
   catch (const ctkCmdLineModuleRunException& e)
   {
     QVERIFY2(e.errorCode() == 24, "Test matching error code");
-    QCOMPARE(future.readAllErrorData().data(), "A superficial error message.\nSome error occured\n");
+    QCOMPARE(future.readAllErrorData().data(), "A superficial error message.\nSome error occurred\n");
   }
 }
 

Libs/CommandLineModules/Testing/Modules/TestBed/ctkCmdLineModuleTestBed.cpp

@@ -67,7 +67,7 @@ int main(int argc, char* argv[])
   parser.addArgument("help", "h", QVariant::Bool, "Show this help text");
   parser.addArgument("xml", "", QVariant::Bool, "Print a XML description of this modules command line interface");
   parser.addArgument("runtime", "", QVariant::Int, "Runtime in seconds", 1);
-  parser.addArgument("numOutputs", "", QVariant::Int, "Number of outpusts", 0);
+  parser.addArgument("numOutputs", "", QVariant::Int, "Number of outputs", 0);
   parser.addArgument("exitCode", "", QVariant::Int, "Exit code", 0);
   parser.addArgument("exitCrash", "", QVariant::Bool, "Force crash", false);
   parser.addArgument("exitTime", "", QVariant::Int, "Exit time", 0);

Libs/Core/Testing/Cpp/ctkAbstractFactoryTest1.cpp

@@ -38,7 +38,7 @@ class FactoryItem : public ctkAbstractFactoryItem<BaseClassType>
     return true;
     }
 protected:
-  /// Must be reimplemented in subclasses to instanciate a BaseClassType*
+  /// Must be reimplemented in subclasses to instantiate a BaseClassType*
   virtual BaseClassType* instanciator()
     {
     return new BaseClassType;

Libs/Core/Testing/Cpp/ctkAbstractPluginFactoryTest1.cpp

@@ -106,7 +106,7 @@ int ctkAbstractPluginFactoryTest1(int argc, char * argv [])
   // ctkDummyPlugin is not a QPushButton, it should fail then.
   ctkAbstractPluginFactory< QTimer > buttonPluginFactory;
   buttonPluginFactory.setVerbose(true);
-  // it should register but fail while instanciating
+  // it should register but fail while instantiating
   itemKey = buttonPluginFactory.registerFileItem(file);
   if (itemKey.isEmpty() || buttonPluginFactory.itemKeys().count() != 1)
     {

Libs/Core/Testing/Cpp/ctkCallbackTest1.cpp

@@ -124,19 +124,19 @@ int ctkCallbackTest1(int argc, char * argv [] )
 
   if (!Done1)
     {
-    std::cerr << "Line " << __LINE__ << " - Probem with ctkCallback" << std::endl;
+    std::cerr << "Line " << __LINE__ << " - Problem with ctkCallback" << std::endl;
     return EXIT_FAILURE;
     }
 
   if (!Done2)
     {
-    std::cerr << "Line " << __LINE__ << " - Probem with ctkCallback::setCallback" << std::endl;
+    std::cerr << "Line " << __LINE__ << " - Problem with ctkCallback::setCallback" << std::endl;
     return EXIT_FAILURE;
     }
 
   if (!Done3)
     {
-    std::cerr << "Line " << __LINE__ << " - Probem with ctkCallback::setCallback" << std::endl;
+    std::cerr << "Line " << __LINE__ << " - Problem with ctkCallback::setCallback" << std::endl;
     return EXIT_FAILURE;
     }
   return EXIT_SUCCESS;

Libs/Core/Testing/Cpp/ctkCommandLineParserTest1.cpp

@@ -55,7 +55,7 @@ int ctkCommandLineParserTest1(int, char*[])
     return EXIT_FAILURE;
     }
 
-  // Test2 - Check if addArgument() for a boolean workes as expected
+  // Test2 - Check if addArgument() for a boolean works as expected
   QStringList arguments2;
   arguments2 << "ctkCommandLineParserTest1";
   arguments2 << "--test-bool";

Libs/Core/Testing/Cpp/ctkExampleWorkflowStepUsingSignalsAndSlots.h

@@ -57,7 +57,7 @@ class ctkExampleWorkflowStepUsingSignalsAndSlotsPrivate;
 /// step->setHasOnEntryCommand(1);
 
 ///
-/// Need two connectins to use this class's onExit() function,
+/// Need two connections to use this class's onExit() function,
 /// and must also set the step's hasOnExitCommand() flag:
 /// QObject::connect(step, SIGNAL(invokeOnExitCommand(const
 /// ctkWorkflowStep*, const

Libs/Core/Testing/Cpp/ctkUtf8Test1.cpp

@@ -77,7 +77,7 @@ int ctkUtf8Test1(int, char*[])
   }
 #endif
 
-  // Check that we can create a file wit utf8 filename using standard file API
+  // Check that we can create a file with utf8 filename using standard file API
   std::string filenameUtf8 = u8"alpha(\u03b1).txt";
   std::ofstream outputFileStream;
   outputFileStream.open(filenameUtf8);

Libs/Core/Testing/Cpp/ctkUtilsCopyDirRecursivelyTest1.cpp

@@ -167,7 +167,7 @@ int ctkUtilsCopyDirRecursivelyTest1(int argc, char * argv [] )
   }
 
   {
-  // Atempt to copy a directory into itself
+  // Attempt to copy a directory into itself
   QString srcPath(tmp.path());
   QString destPath(tmp.path() + "/dest");
   if (ctk::copyDirRecursively(srcPath, destPath))

Libs/Core/Testing/Cpp/ctkUtilsTest.cpp

@@ -196,9 +196,9 @@ void ctkUtilsTester::testSignificantDecimals_data()
   QTest::newRow("123456.3333334 -> 2") << 123456.3333334 << -1 << 2;
   QTest::newRow("123456.00122 -> 5") << 123456.00122 << -1 << 5;
   QTest::newRow("123456.00123 -> 5") << 123456.00123 << -1 << 5;
-  // internally representated as 123456.001109999997425
+  // internally represented as 123456.001109999997425
   QTest::newRow("123456.00111 -> 5") << 123456.00111 << -1 << 5;
-  // internally representated as 123456.270000000004075
+  // internally represented as 123456.270000000004075
   QTest::newRow("123456.26999999999999996 -> 2")
     << 123456.26999999999999996 << -1 << 2;
   QTest::newRow("123456.863899999999987 -> 4") << 123456.863899999999987 << -1 << 4;
@@ -234,9 +234,9 @@ void ctkUtilsTester::testSignificantDecimals_data()
   QTest::newRow("123456.3333334 -> 2") << 123456.3333334 << 3 << 2;
   QTest::newRow("123456.00122 -> 5") << 123456.00122 << 3 << 5;
   QTest::newRow("123456.00123 -> 5") << 123456.00123 << 3 << 5;
-  // internally representated as 123456.001109999997425
+  // internally represented as 123456.001109999997425
   QTest::newRow("123456.00111 -> 5") << 123456.00111 << 3 << 5;
-  // internally representated as 123456.270000000004075
+  // internally represented as 123456.270000000004075
   QTest::newRow("123456.26999999999999996 -> 2")
     << 123456.26999999999999996 << 3 << 2;
   QTest::newRow("123456.863899999999987 -> 4") << 123456.863899999999987 << 3 << 4;

Libs/Core/Testing/Cpp/ctkUtilsTest3.cpp

@@ -52,7 +52,7 @@ int ctkUtilsTest3(int argc, char * argv [] )
     qWarning() << "Line" << __LINE__ << "ctk::nameFiltersToRegExp() failed: ";
     return EXIT_FAILURE;
     }
-  //add test if it take all the extension, test with exemples
+  //add test if it take all the extension, test with examples
   if (!dummyRegExp.exactMatch("c:/foo.jpg"))
     {
     qWarning() << "Line" << __LINE__ << "ctk::nameFiltersToRegExp() failed: ";

Libs/Core/Testing/Cpp/ctkWorkflowTest2.cpp

@@ -221,7 +221,7 @@ int ctkWorkflowTest2(int argc, char * argv [] )
   // add the fourth step
   if (!workflow->addTransition(step3, step4))
     {
-    std::cerr << "could not add 4rd step" << std::endl;
+    std::cerr << "could not add 4th step" << std::endl;
     return EXIT_FAILURE;
     }
 

Libs/Core/Testing/Cpp/ctkWorkflowTest3.cpp

@@ -87,7 +87,7 @@ int ctkWorkflowTest3(int argc, char * argv [] )
     return EXIT_FAILURE;
     }
 
-  // test that the transitions are occuring properly
+  // test that the transitions are occurring properly
   workflow->start();
   QTimer::singleShot(defaultTime, &app, SLOT(quit()));
   app.exec();

Libs/Core/ctkAbstractFactory.h

@@ -76,7 +76,7 @@ class ctkAbstractFactoryItem
   void appendLoadWarningString(const QString& msg);
   void clearLoadWarningStrings();
 
-  /// Must be reimplemented in subclasses to instanciate a BaseClassType*
+  /// Must be reimplemented in subclasses to instantiate a BaseClassType*
   virtual BaseClassType* instanciator() = 0;
   BaseClassType* Instance;
 
@@ -93,7 +93,7 @@ class ctkAbstractFactoryItem
 /// \brief ctkAbstractFactory is the base class of all the factory where items need
 /// to be registered before being instantiated.
 /// <p> ctkAbstractFactory contains a collection of ctkAbstractFactoryItems that
-/// are uniquely identifyed by a key. Subclasses of ctkAbstractFactory are
+/// are uniquely identified by a key. Subclasses of ctkAbstractFactory are
 /// responsible for populating the list of ctkAbstractFactoryItems.
 /// BaseClassType could be any type (most probably a QObject)
 template<typename BaseClassType>
@@ -103,7 +103,7 @@ class ctkAbstractFactory
 
   typedef QHash<QString, QSharedPointer<ctkAbstractFactoryItem<BaseClassType> > > HashType;
 
-  /// Constructor/Desctructor
+  /// Constructor/Destructor
   ctkAbstractFactory();
   virtual ~ctkAbstractFactory();
   virtual void printAdditionalInfo();
@@ -116,7 +116,7 @@ class ctkAbstractFactory
   /// return 0.
   virtual BaseClassType * instance(const QString& itemKey);
 
-  /// \brief Uninstanciate the object.
+  /// \brief Uninstantiate the object.
   /// Do nothing if the item given by the key has not be instantiated nor registered.
   void uninstantiate(const QString& itemKey);
 
@@ -145,7 +145,7 @@ class ctkAbstractFactory
                             const QString& status, bool display);
 
   /// \brief Call the load method associated with the item.
-  /// If succesfully loaded, add it to the internal map.
+  /// If successfully loaded, add it to the internal map.
   bool registerItem(const QString& key, const QSharedPointer<ctkAbstractFactoryItem<BaseClassType> > & item);
 
   /// Get a Factory item given its itemKey. Return 0 if any.