libcamera: Rename 'method' to 'function'

Usage of 'method' to refer to member functions comes from Java. The C++
standard uses the term 'function' only. Replace 'method' with 'function'
or 'member function' through the whole code base and documentation.
While at it, fix two typos (s/backeng/backend/).

The BoundMethod and Object::invokeMethod() are left as-is here, and will
be addressed separately.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>
Acked-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
This commit is contained in:
Laurent Pinchart
2021-08-09 15:40:32 +03:00
parent 0536a9aa71
commit a48a000a33
53 changed files with 314 additions and 309 deletions
+9 -8
View File
@@ -276,7 +276,7 @@ SizeRange StreamFormats::range(const PixelFormat &pixelformat) const
*/
/**
* \todo This method is deprecated and should be removed once all pipeline
* \todo This function is deprecated and should be removed once all pipeline
* handlers provide StreamFormats.
*/
StreamConfiguration::StreamConfiguration()
@@ -334,7 +334,7 @@ StreamConfiguration::StreamConfiguration(const StreamFormats &formats)
* \brief Retrieve the stream associated with the configuration
*
* When a camera is configured with Camera::configure() Stream instances are
* associated with each stream configuration entry. This method retrieves the
* associated with each stream configuration entry. This function retrieves the
* associated Stream, which remains valid until the next call to
* Camera::configure() or Camera::release().
*
@@ -345,8 +345,8 @@ StreamConfiguration::StreamConfiguration(const StreamFormats &formats)
* \fn StreamConfiguration::setStream()
* \brief Associate a stream with a configuration
*
* This method is meant for the PipelineHandler::configure() method and shall
* not be called by applications.
* This function is meant for the PipelineHandler::configure() function and
* shall not be called by applications.
*
* \param[in] stream The stream
*/
@@ -355,10 +355,11 @@ StreamConfiguration::StreamConfiguration(const StreamFormats &formats)
* \fn StreamConfiguration::formats()
* \brief Retrieve advisory stream format information
*
* This method retrieves information about the pixel formats and sizes supported
* by the stream configuration. The sizes are advisory and not all of them are
* guaranteed to be supported by the stream. Users shall always inspect the size
* in the stream configuration after calling CameraConfiguration::validate().
* This function retrieves information about the pixel formats and sizes
* supported by the stream configuration. The sizes are advisory and not all of
* them are guaranteed to be supported by the stream. Users shall always inspect
* the size in the stream configuration after calling
* CameraConfiguration::validate().
*
* \return Stream formats information
*/