Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Fix remaining doxy/source comment typos #1036

Merged
merged 1 commit into from
Aug 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Applications/Testing/Cpp/dcmqrscp.cfg.in
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ HostTable BEGIN
# DICOM Application Entities. A symbolic name can represent a single
# application entity or it can represent a group of application entities.
# Each DICOM application entity is defined by a triple consisting of
# Application Entitiy Title, host name and TCP/IP port number.
# Application Entity Title, host name and TCP/IP port number.
#
# Entry Format: SymbolicName = ( AETitle, HostName, Portnumber ), ... |
# SymbolicName = SymbolicName, ...
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ ctkCLModuleExplorerMainWindow::ctkCLModuleExplorerMainWindow(QWidget *parent) :
// Due to Qt bug 12152, we cannot listen to the "paused" signal because it is
// not emitted directly when the QFuture is paused. Instead, it is emitted after
// resuming the future, after the "resume" signal has been emitted... we use
// a polling aproach instead.
// a polling approach instead.
pollPauseTimer.setInterval(300);
connect(&pollPauseTimer, SIGNAL(timeout()), SLOT(checkModulePaused()));
connect(&currentFutureWatcher, SIGNAL(resumed()), SLOT(currentModuleResumed()));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ ctkCmdLineModuleExplorerProgressWidget::ctkCmdLineModuleExplorerProgressWidget(Q
// Due to Qt bug 12152, we cannot listen to the "paused" signal because it is
// not emitted directly when the QFuture is paused. Instead, it is emitted after
// resuming the future, after the "resume" signal has been emitted... we use
// a polling aproach instead.
// a polling approach instead.
PollPauseTimer.setInterval(300);
connect(&PollPauseTimer, SIGNAL(timeout()), SLOT(checkModulePaused()));

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class ctkTestWrappedQListOfVTKObject : public QObject
{
}

/// Example ot slot accepting a VTK object as parameter
/// Example of slot accepting a VTK object as parameter
Q_INVOKABLE int numberOfElementInList(const QList<vtkTable*>& listOfTable)
{
return listOfTable.count();
Expand Down
2 changes: 1 addition & 1 deletion Applications/ctkSimplePythonShell/ctkTestWrappedVTKSlot.h
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public Q_SLOTS:
return this->MyTable;
}

/// Example ot slot accepting a VTK object as parameter
/// Example of slot accepting a VTK object as parameter
void setTable(vtkTable * newTable)
{
this->MyTable = newTable;
Expand Down
2 changes: 1 addition & 1 deletion Libs/PluginFramework/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ if(CTK_QT_VERSION VERSION_GREATER "4")
endif()

# Create a MANIFEST.MF resource for the PluginFramework library,
# pretending that is is a plugin (the system plugin)
# pretending that it is a plugin (the system plugin)
ctkFunctionGeneratePluginManifest(KIT_SRCS
SYMBOLIC_NAME "system.plugin"
VERSION "0.9.9"
Expand Down
2 changes: 1 addition & 1 deletion Libs/PluginFramework/ctkPluginEvent.h
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class ctkPluginEventData;
* <code>ctkPluginEvent</code> objects are delivered to slots connected
* via ctkPluginContext::connectPluginListener() when a change
* occurs in a plugins's lifecycle. A type code is used to identify
* the event type for future extendability.
* the event type for future extendibility.
*
* @see ctkPluginContext#connectPluginListener
*/
Expand Down
2 changes: 1 addition & 1 deletion Libs/PluginFramework/ctkPluginException.h
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* A <code>ctkPluginException</code> object is created by the Framework to denote
* an exception condition in the lifecycle of a plugin.
* <code>ctkPluginException</code>s should not be created by plugin developers.
* An enum type is used to identify the exception type for future extendability.
* An enum type is used to identify the exception type for future extendibility.
*
* <p>
* This exception conforms to the general purpose exception chaining mechanism.
Expand Down
2 changes: 1 addition & 1 deletion Libs/PluginFramework/ctkPluginFrameworkEvent.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class ctkPluginFrameworkEventData;
* <code>ctkPluginFrameworkEvent</code> objects are delivered to slots connected
* via ctkPluginContext::connectFrameworkListener when a general event occurs
* within the plugin environment.
* A type code is used to identify the event type for future extendability.
* A type code is used to identify the event type for future extendibility.
*
* @see ctkPluginContext#connectFrameworkListener
* @see ctkEventBus
Expand Down
2 changes: 1 addition & 1 deletion Libs/PluginFramework/ctkServiceEvent.h
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ class ctkServiceEventData;
* <code>ctkServiceEvent</code> objects are delivered to
* slots connected via ctkPluginContext::connectServiceListener() when a
* change occurs in this service's lifecycle. A type code is used to identify
* the event type for future extendability.
* the event type for future extendibility.
*/
class CTK_PLUGINFW_EXPORT ctkServiceEvent
{
Expand Down
2 changes: 1 addition & 1 deletion Libs/PluginFramework/ctkServiceException.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
* <p>
* A <code>ctkServiceException</code> object is created by the Framework or
* to denote an exception condition in the service. An enum
* type is used to identify the exception type for future extendability.
* type is used to identify the exception type for future extendibility.
*
* <p>
* This exception conforms to the general purpose exception chaining mechanism.
Expand Down
2 changes: 1 addition & 1 deletion Libs/PluginFramework/service/cm/ctkConfigurationAdmin.h
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ struct CTK_PLUGINFW_EXPORT ctkConfigurationAdmin

/**
* Configuration property naming the location of the plugin that is
* associated with a a <code>ctkConfiguration</code> object. This property can
* associated with a <code>ctkConfiguration</code> object. This property can
* be searched for but must not appear in the configuration dictionary for
* security reason. The property's value is of type <code>QString</code>.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ struct CTK_PLUGINFW_EXPORT ctkAttributeDefinition
* is used to uniquely identify an attribute. If such an OID exists, (which
* can be requested at several standard organisations and many companies
* already have a node in the tree) it can be returned here. Otherwise, a
* unique id should be returned which can be a class name combined with a a reverse
* unique id should be returned which can be a class name combined with a reverse
* domain name or generated with a GUID algorithm. Note that all LDAP
* defined attributes already have an OID. It is strongly advised to define
* the attributes from existing LDAP schemes which will give the OID. Many
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ class org_commontk_dah_core_EXPORT ctkDicomAbstractExchangeCache : public QObjec
bool notifyDataAvailable(const ctkDicomAppHosting::AvailableData& data, bool lastData);

/**
* @brief Clean internal data stucture that keeps the incoming data.
* @brief Clean internal data structure that keeps the incoming data.
*
* Called when other side is gone (i.e., usually the other side is a hosted app).
*
Expand Down
4 changes: 2 additions & 2 deletions Plugins/org.commontk.dah.core/ctkDicomAvailableDataHelper.h
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ bool org_commontk_dah_core_EXPORT appendToAvailableData(ctkDicomAppHosting::Avai
*
* Result can be used to retrieve data by calling ctkDicomExchangeInterface::getData.
*
* \return alls UUIDs of data for patient inside available data, otherwise empty.
* \return all UUIDs of data for patient inside available data, otherwise empty.
*/
QList<QUuid> org_commontk_dah_core_EXPORT getAllUuids(const ctkDicomAppHosting::Patient& patient);

Expand All @@ -120,7 +120,7 @@ QList<QUuid> org_commontk_dah_core_EXPORT getAllUuids(const ctkDicomAppHosting::
*
* Result can be used to retrieve data by calling ctkDicomExchangeInterface::getData.
*
* \return alls UUIDs of all data inside available data, otherwise empty.
* \return all UUIDs of all data inside available data, otherwise empty.
*/
QList<QUuid> org_commontk_dah_core_EXPORT getAllUuids(const ctkDicomAppHosting::AvailableData& availableData);

Expand Down
2 changes: 1 addition & 1 deletion Plugins/org.commontk.eventadmin/ctkEAConfiguration_p.h
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ class ctkEAAbstractAdapter;
* If a timeout is configured by default all event handlers are called using the timeout.
* For performance optimization it is possible to configure event handlers where the
* timeout handling is not used - this reduces the thread usage from the thread pools
* as the timout handling requires an additional thread to call the event handler.
* as the timeout handling requires an additional thread to call the event handler.
* However, the application should work without this configuration property. It is a
* pure optimization!
* The value is a list of strings (separated by comma) which is assumed to define
Expand Down
2 changes: 1 addition & 1 deletion Plugins/org.commontk.eventadmin/ctkEAMetaTypeProvider.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ ctkObjectClassDefinitionPtr ctkEAMetaTypeProvider::getObjectClassDefinition(cons
"Configure event handlers to be called without a timeout. If a timeout is configured by default "
"all event handlers are called using the timeout. For performance optimization it is possible to "
"configure event handlers where the timeout handling is not used - this reduces the thread usage "
"from the thread pools as the timout handling requires an additional thread to call the event "
"from the thread pools as the timeout handling requires an additional thread to call the event "
"handler. However, the application should work without this configuration property. It is a "
"pure optimization! The value is a list of strings (separated by comma) which is assumed to define "
"exact class names.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ struct ctkEALinkedNode
* and takes when the queue is not empty.
* Normally a put and a take can proceed simultaneously.
* (Although it does not allow multiple concurrent puts or takes.)
* This class tends to perform more efficently than
* This class tends to perform more efficiently than
* other ctkEAChannel implementations in producer/consumer
* applications.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ class ctkEAInterruptibleThread;
* Queue sizes and maximum pool sizes can often be traded off for
* each other. Using large queues and small pools minimizes CPU
* usage, OS resources, and context-switching overhead, but can lead
* to artifically low throughput. Especially if tasks frequently
* to artificially low throughput. Especially if tasks frequently
* block (for example if they are I/O bound), the underlying
* OS may be able to schedule time for more threads than you
* otherwise allow. Use of small queues or queueless handoffs
Expand Down Expand Up @@ -380,7 +380,7 @@ class ctkEAPooledExecutor : public ctkEAThreadFactoryUser
/** The maximum number of threads allowed in pool. **/
int maximumPoolSize_;

/** The minumum number of threads to maintain in pool. **/
/** The minimum number of threads to maintain in pool. **/
int minimumPoolSize_;

/** Current pool size. **/
Expand Down Expand Up @@ -448,7 +448,7 @@ class ctkEAPooledExecutor : public ctkEAThreadFactoryUser

/**
* Return the minimum number of threads to simultaneously execute.
* (Default value is 1). If fewer than the mininum number are
* (Default value is 1). If fewer than the minimum number are
* running upon reception of a new request, a new thread is started
* to handle this request.
**/
Expand All @@ -466,7 +466,7 @@ class ctkEAPooledExecutor : public ctkEAThreadFactoryUser

/**
* Return the current number of active threads in the pool. This
* number is just a snaphot, and may change immediately upon
* number is just a snapshot, and may change immediately upon
* returning
**/
int getPoolSize() const;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@


/**
* Used to execute synchronuous tasks. This is not done
* Used to execute synchronous tasks. This is not done
* in the main thread because we need to be able to
* interrupt the thread waiting on a synchronuous task
* interrupt the thread waiting on a synchronous task
* (for example on a timeout). ctkEAInterruptibleThread
* provides this capability.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ class ctkEACyclicBarrier
* @throws ctkEAInterruptedException if this thread was interrupted
* during the barrier. If so, <code>broken</code> status is also set.
* @throws ctkEATimeoutException if this thread timed out waiting for
* the barrier. If the timeout occured while already in the
* the barrier. If the timeout occurred while already in the
* barrier, <code>broken</code> status is also set.
**/
int attemptBarrier(long msecs);
Expand Down
2 changes: 1 addition & 1 deletion Plugins/org.commontk.eventbus/Testing/Cpp/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ macro(ctkMacroInitProject test)
foreach(FILE_NAME_ABS ${implementation_file_list})
## extract the base file name.
get_filename_component(FILE_NAME ${FILE_NAME_ABS} NAME_WE)
## Exclude the main.cpp file (it doesn't ned to be 'mocced')
## Exclude the main.cpp file (it doesn't need to be 'mocced')
if(NOT ${FILE_NAME} STREQUAL "main")
## Assign the moc custom filename
set(MOC_FILE "${FILE_NAME}.moc")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class testObjectCustom : public QObject {
/// constructor.
testObjectCustom();

/// Return tha var's value.
/// Return the var's value.
int var() {return m_Var;}

/// register a custom callback
Expand Down Expand Up @@ -84,7 +84,7 @@ class testNetworkConnectorForEventBus : public ctkNetworkConnector {
/// Create and initialize client
/*virtual*/ void createClient(QString hostName, unsigned int port);

/// Return the string variable initializated and updated from the data pipe.
/// Return the string variable initialized and updated from the data pipe.
/*virtual*/ void createServer(unsigned int port);

/// Allow to send a network request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class testObjectCustomForNetworkConnectorXMLRPC : public QObject {
/// constructor.
testObjectCustomForNetworkConnectorXMLRPC();

/// Return tha var's value.
/// Return the var's value.
int var() {return m_Var;}

public Q_SLOTS:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class testObjectCustomForNetworkConnectorSoap : public QObject {
/// constructor.
testObjectCustomForNetworkConnectorSoap();

/// Return tha var's value.
/// Return the var's value.
int var() {return m_Var;}

public Q_SLOTS:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class testNetworkConnectorCustom : public ctkNetworkConnector {
/// Create and initialize client
/*virtual*/ void createClient(const QString hostName, const unsigned int port);

/// Return the string variable initializated and updated from the data pipe.
/// Return the string variable initialized and updated from the data pipe.
/*virtual*/ void createServer(const unsigned int port);

/// Allow to send a network request.
Expand Down Expand Up @@ -122,7 +122,7 @@ private Q_SLOTS:
void ctkNetworkConnectorAllocationTest();
/// Test the creation of client and server.
void ctkNetworkConnectorCreateClientAndServerTest();
/// test the function that retrive protocol type
/// test the function that retrieve protocol type
void retrieveProtocolTest();

private:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class testObjectCustomForNetworkConnectorZeroMQ : public QObject {
/// constructor.
testObjectCustomForNetworkConnectorZeroMQ();

/// Return tha var's value.
/// Return the var's value.
int var() {return m_Var;}

public Q_SLOTS:
Expand Down
2 changes: 1 addition & 1 deletion Plugins/org.commontk.eventbus/ctkEventBusManager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ ctkEventBusManager::~ctkEventBusManager() {
}
m_NetworkConnectorHash.clear();

//disconnet detachFromEventBus
//disconnect detachFromEventBus
m_SkipDetach = true;

if(m_LocalDispatcher) {
Expand Down
4 changes: 2 additions & 2 deletions Plugins/org.commontk.eventbus/ctkEventBusManager.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class org_commontk_eventbus_EXPORT ctkEventBusManager : public QObject {
static ctkEventBusManager *instance();

/// Add a new event property (observer or event) to the event bus hash.
/** Return true if observer has beed added correctly, false otherwise.
/** Return true if observer has been added correctly, false otherwise.
This method check before adding a new observer that it has not already been inserted into the events' Hash with the same id and callback signature.*/
bool addEventProperty(ctkBusEvent &props) const;

Expand Down Expand Up @@ -63,7 +63,7 @@ class org_commontk_eventbus_EXPORT ctkEventBusManager : public QObject {
/// Enable/Disable event logging to allow dumping events notification into the selected logging output stream.
void enableEventLogging(bool enable = true);

/// When logging is enabled, allows logging events releted to specific id (require a valid topic).
/// When logging is enabled, allows logging events related to specific id (require a valid topic).
void logEventTopic(const QString topic);

/// When enabled, allows logging all events. It reset the value for m_LogEventId to -1 (the default)
Expand Down
6 changes: 3 additions & 3 deletions Plugins/org.commontk.eventbus/ctkEventDispatcher.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class org_commontk_eventbus_EXPORT ctkEventDispatcher : public QObject {
virtual ~ctkEventDispatcher();

/// Add the observer to the events.
/** Return true if observer has beed added correctly, false otherwise.
/** Return true if observer has been added correctly, false otherwise.
This method check before adding a new observer that it has not already been inserted into the events' Hash with the same id and callback signature.*/
bool addObserver(ctkBusEvent &props);

Expand All @@ -45,7 +45,7 @@ class org_commontk_eventbus_EXPORT ctkEventDispatcher : public QObject {
bool removeSignal(const QObject *obj, const QString topic = "", bool qt_disconnect = true);

/// register custom signals use by objects to raise them events.
/** Return true if signal has beed added correctly, false otherwise.
/** Return true if signal has been added correctly, false otherwise.
This method check before adding a new signal that it has not already been inserted into the events' Hash with the same id and signal signature.
WARNING: due to Qt limitation you cannot use the same signal in different Topics.*/
bool registerSignal(ctkBusEvent &props);
Expand Down Expand Up @@ -76,7 +76,7 @@ class org_commontk_eventbus_EXPORT ctkEventDispatcher : public QObject {
/// Register MAF global events
virtual void initializeGlobalEvents();

/// Interanl method used to remove the given event property.
/// Internal method used to remove the given event property.
bool removeEventItem(ctkBusEvent &props);

/// Return the signal item property associated to the given ID.
Expand Down
2 changes: 1 addition & 1 deletion Plugins/org.commontk.eventbus/ctkEventHandlerWrapper_p.h
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ class ctkEventHandlerWrapper : public QObject {
catch (const std::exception& e)
{
// TODO logging
std::cerr << "Exception occured during publishing " << qPrintable(event.getTopic()) << ": " << e.what() << std::endl;
std::cerr << "Exception occurred during publishing " << qPrintable(event.getTopic()) << ": " << e.what() << std::endl;
}

}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ void ctkNetworkConnectorQtSoap::createClient(const QString hostName, const unsig

//registration of the method REMOTE_COMMUNICATION_SOAP at Soap level
// this method need to reflect the name of the action of the service while QVariant::List are list of
// strings, in which each string represent the correct name of the parameter in the sevice function.
// strings, in which each string represent the correct name of the parameter in the service function.
registerServerMethod("testArray", parametersForRegisterteredFunction);

//
Expand Down
2 changes: 1 addition & 1 deletion Plugins/org.commontk.eventbus/ctkNetworkConnectorZeroMQ.h
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ private Q_SLOTS:
//here goes zeromq vars

private:
//here ges function for zeromq connection
//here goes function for zeromq connection

/// stop and destroy the server instance.
void stopServer();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ QString ctkAttributeDefinitionImpl::validate(const QString& value) const
return QString();
}

// Addtional validation for STRING.
// Additional validation for STRING.
// PASSWORD is treated like STRING.
if ((_dataType == QVariant::String || _dataType == QVariant::UserType) && _values.size() > 0 && !_values.contains(value))
{
Expand Down
2 changes: 1 addition & 1 deletion Plugins/org.commontk.metatype/ctkMTDataParser.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,7 @@ void ctkMTDataParser::attributeDefinitionHandler(QList<ctkAttributeDefinitionImp

if (ad_cardinality_val == 0)
{
// Attribute DEFAULT has one and only one occurance.
// Attribute DEFAULT has one and only one occurrence.
ad->setDefaultValue(QStringList(ad_defaults_str), false);
}
else
Expand Down
Loading