Merge branch 'cli-module-support'

* cli-module-support:
  Improved command line module documentation.

Libs/CommandLineModules/Backend/FunctionPointer/README.md

@@ -1,6 +1,9 @@
 Function Pointer (experimental)    {#CommandLineModulesBackendFunctionPointer_Page}
 ===============================
 
+\internal This page is best viewed in its [Doxygen processed]
+(http://www.commontk.org/docs/html/CommandLineModulesBackendFunctionPointer_Page.html) form. \endinternal
+
 The Function Pointer back-end is an experimental *proof-of-concept* (however, it is used in
 some unit tests as a light-weight back-end).
 

Libs/CommandLineModules/Backend/LocalProcess/README.md

@@ -1,6 +1,9 @@
 Local Process    {#CommandLineModulesBackendLocalProcess_Page}
 =============
 
+\internal This page is best viewed in its [Doxygen processed]
+(http://www.commontk.org/docs/html/CommandLineModulesBackendLocalProcess_Page.html) form. \endinternal
+
 The Local Process back-end is a fully featured back-end implementation for handling executable
 modules. When registered with a ctkCmdLineModuleManager instance, it will handle the registration
 of all modules with a "file" location URL scheme. See the ctkCmdLineModuleBackendLocalProcess class

Libs/CommandLineModules/Core/README.md

@@ -1,6 +1,9 @@
 Core    {#CommandLineModulesCore_Page}
 ====
 
+\internal This page is best viewed in its [Doxygen processed]
+(http://www.commontk.org/docs/html/CommandLineModulesCore_Page.html) form. \endinternal
+
 The Command Line Modules Core library provides high-level classes to manage command line modules.
 
 It provides abstract classes for working with back and front ends and a central management class

Libs/CommandLineModules/Core/ctkCmdLineModuleManager.h

@@ -114,7 +114,7 @@ public:
   void registerBackend(ctkCmdLineModuleBackend* backend);
 
   /**
-   * @brief Registers a module, identified by the give URL.
+   * @brief Registers a module, identified by the given URL.
    * @param location The URL for the new module.
    * @return A module reference.
    * @throws ctkInvalidArgumentException if no back-end for the given URL scheme was registered

Libs/CommandLineModules/Frontend/QtGui/README.md

@@ -1,6 +1,9 @@
 Qt Gui Frontend    {#CommandLineModulesFrontendQtGui_Page}
 ===============
 
+\internal This page is best viewed in its [Doxygen processed]
+(http://www.commontk.org/docs/html/CommandLineModulesFrontendQtGui_Page.html) form. \endinternal
+
 The Qt Gui front-end uses a customizable XML stylesheet to transform the raw XML module
 description into Qt .ui file. For details about the configuration possibilities of the GUI
 generation process see the ctkCmdLineModuleFrontendQtGui class.

Libs/CommandLineModules/Frontend/QtWebKit/README.md

@@ -1,10 +1,13 @@
 Qt WebKit Frontend (experimental)    {#CommandLineModulesFrontendQtWebKit_Page}
 =================================
 
+\internal This page is best viewed in its [Doxygen processed]
+(http://www.commontk.org/docs/html/CommandLineModulesFrontendQtWebKit_Page.html) form. \endinternal
+
 This front-end uses an XML stylesheet to transform the raw XML description of a module
 into a HTML document and uses Qt WebKit to render this document inside a Qt widget.
 
 The front-end is experimental and serves as a *proof-of-concept*, see also the
 ctkCmdLineModuleFrontendQtWebKit class.
 
-See the \ref CommandLineModulesFrontendFactoryQtWebKit_API module for the API documentation.
+See the \ref CommandLineModulesFrontendQtWebKit_API module for the API documentation.

Libs/CommandLineModules/README.md

@@ -3,6 +3,9 @@ CTK Command Line Modules   {#CommandLineModules_Page}
 
 \brief Overview about the Command Line Modules support in CTK.
 
+\internal This page is best viewed in its [Doxygen processed]
+(http://www.commontk.org/docs/html/CommandLineModules_Page.html) form. \endinternal
+
 [TOC]
 
 CTK provides an API for interfacing with self-describing *runnable* modules which can provide an
@@ -12,7 +15,7 @@ usually (but not constrained to) a local executable and also referred to as a *c
 The XML schema for the parameter description and most of the supported feature set for a module
 has been adopted from the [Slicer Execution Model](http://www.slicer.org/slicerWiki/index.php/Slicer3:Execution_Model_Documentation).
 
-The API provided by CTK allows the management, GUI generation, and asynchronuous execution
+The API provided by CTK allows the management, GUI generation, and asynchronous execution
 of such modules in a toolkit-independent and interoperable way. Application writers can rely on the
 provided libraries and their API to quickly integrate command line modules into their applications.
 
@@ -33,7 +36,7 @@ Here is short overview about the provided feature set:
 - XML validation and error reporting
 - Caching of XML descriptions
 - Partially thread-safe, allowing to concurrently add and remove modules
-- Asynchronuous communication with running modules
+- Asynchronous communication with running modules
   + Start/pause/cancel support (back-end and operating system dependent)
   + Result reporting
   + Output reporting
@@ -108,11 +111,11 @@ 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::register(const QUrl&) method, providing the URL to the module. If the URL scheme is not handled
+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
 ctkCmdLineModuleReference object.
 
-Creating specific front-ends for a given module is actually independent of the ctkModuleManagerManager, except that a
+Creating specific front-ends for a given module is actually independent of the ctkCmdLineModuleManager, except that a
 ctkCmdLineModuleReference object is needed. To create a front-end, usually the
 ctkCmdLineModuleFrontendFactory::create(const ctkCmdLineModuleReference&) method is called, returning a
 ctkCmdLineModuleFrontend pointer.