summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKieran Bingham <kieran.bingham@ideasonboard.com>2019-07-10 21:50:53 +0100
committerKieran Bingham <kieran.bingham@ideasonboard.com>2019-07-15 09:35:10 +0100
commitef98f90a4fdd3242471295d680e96f9a651f1d33 (patch)
tree68a2958abcbea7f71a97633b9682e3da4e15606a
parente1a5873701a95ad508b705945201d836c49eab0c (diff)
libcamera: Fix spellings and grammar
Fix a number of spelling errors and word duplications throughout the comments within libcamera. These were picked up with spellintian. Also one capitalisation of the first word of a \return statement picked up by checkstyle.py while creating this patch. Reviewed-by: Paul Elder <paul.elder@ideasonboard.com> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
-rw-r--r--src/libcamera/buffer.cpp2
-rw-r--r--src/libcamera/camera.cpp2
-rw-r--r--src/libcamera/controls.cpp2
-rw-r--r--src/libcamera/ipa_module.cpp2
-rw-r--r--src/libcamera/pipeline_handler.cpp2
-rw-r--r--src/libcamera/stream.cpp2
-rw-r--r--src/libcamera/v4l2_device.cpp2
7 files changed, 7 insertions, 7 deletions
diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp
index fe29c2f6..4407201b 100644
--- a/src/libcamera/buffer.cpp
+++ b/src/libcamera/buffer.cpp
@@ -321,7 +321,7 @@ Buffer::Buffer(unsigned int index, const Buffer *metadata)
* \fn Buffer::timestamp()
* \brief Retrieve the time when the buffer was processed
*
- * The timestamp is expressed as a number number of nanoseconds since the epoch.
+ * The timestamp is expressed as a number of nanoseconds since the epoch.
*
* \return Timestamp when the buffer was processed
*/
diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
index f2deb38d..76c737cb 100644
--- a/src/libcamera/camera.cpp
+++ b/src/libcamera/camera.cpp
@@ -757,7 +757,7 @@ int Camera::freeBuffers()
* \param[in] cookie Opaque cookie for application use
*
* This method creates an empty request for the application to fill with
- * buffers and paramaters, and queue for capture.
+ * buffers and parameters, and queue for capture.
*
* The \a cookie is stored in the request and is accessible through the
* Request::cookie() method at any time. It is typically used by applications
diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
index d9fbd46d..727fdbd9 100644
--- a/src/libcamera/controls.cpp
+++ b/src/libcamera/controls.cpp
@@ -204,7 +204,7 @@ std::string ControlValue::toString() const
* \var Contrast
* ControlType: Integer
*
- * Specify a fixed constrast parameter.
+ * Specify a fixed contrast parameter.
*/
/**
diff --git a/src/libcamera/ipa_module.cpp b/src/libcamera/ipa_module.cpp
index f9e0896c..00361162 100644
--- a/src/libcamera/ipa_module.cpp
+++ b/src/libcamera/ipa_module.cpp
@@ -348,7 +348,7 @@ close:
* the IPA module information it contains was successfully retrieved and
* validated.
*
- * \return true if the the IPAModule is valid, false otherwise
+ * \return True if the IPAModule is valid, false otherwise
*/
bool IPAModule::isValid() const
{
diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
index 83938a71..3e54aa23 100644
--- a/src/libcamera/pipeline_handler.cpp
+++ b/src/libcamera/pipeline_handler.cpp
@@ -149,7 +149,7 @@ PipelineHandler::~PipelineHandler()
* return false.
*
* If multiple instances of a pipeline are available in the system, the
- * PipelineHandler class will be instanciated once per instance, and its match()
+ * PipelineHandler class will be instantiated once per instance, and its match()
* function called for every instance. Each call shall acquire media devices for
* one pipeline instance, until all compatible media devices are exhausted.
*
diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp
index ed91be7f..de505d12 100644
--- a/src/libcamera/stream.cpp
+++ b/src/libcamera/stream.cpp
@@ -649,7 +649,7 @@ void Stream::destroyBuffers()
* \var Stream::bufferPool_
* \brief The pool of buffers associated with the stream
*
- * The stream buffer pool is populated by the Camera class after a succesfull
+ * The stream buffer pool is populated by the Camera class after a successful
* stream configuration.
*/
diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp
index e3ec44a7..9a00566a 100644
--- a/src/libcamera/v4l2_device.cpp
+++ b/src/libcamera/v4l2_device.cpp
@@ -30,7 +30,7 @@ LOG_DEFINE_CATEGORY(V4L2)
*
* The V4L2Device class groups together the methods and fields common to
* both the V4L2VideoDevice and V4L2Subdevice classes, and provides a base
- * class whith methods to open and close the device node associated with the
+ * class with methods to open and close the device node associated with the
* device and to perform IOCTL system calls on it.
*
* The V4L2Device class cannot be instantiated directly, as its constructor