libcamera: Drop remaining file name from header comment blocks

Source files in libcamera start by a comment block header, which
includes the file name and a one-line description of the file contents.
While the latter is useful to get a quick overview of the file contents
at a glance, the former is mostly a source of inconvenience. The name in
the comments can easily get out of sync with the file name when files
are renamed, and copy & paste during development have often lead to
incorrect names being used to start with.

Readers of the source code are expected to know which file they're
looking it. Drop the file name from the header comment blocks in all
remaining locations that were not caught by the automated script as they
are out of sync with the file name.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
This commit is contained in:
Laurent Pinchart 2024-05-08 19:28:06 +03:00
parent 829acb3ab0
commit 3cb20bc230
40 changed files with 40 additions and 43 deletions

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2021, Google Inc. * Copyright (C) 2021, Google Inc.
* *
* thread_annotation.h - Macro of Clang thread safety analysis * Macro of Clang thread safety analysis
*/ */
#pragma once #pragma once

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2021, Google Inc. * Copyright (C) 2021, Google Inc.
* *
* internal/fence.h - Synchronization fence * Synchronization fence
*/ */
#pragma once #pragma once

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2019, Google Inc. * Copyright (C) 2019, Google Inc.
* *
* camera_ops.h - Android Camera HAL Operations * Android Camera HAL Operations
*/ */
#include "camera_ops.h" #include "camera_ops.h"

View file

@ -2,8 +2,7 @@
/* /*
* Copyright (C) 2021, Google Inc. * Copyright (C) 2021, Google Inc.
* *
* cros_frame_buffer.cpp - Allocate FrameBuffer for Chromium OS using * Allocate FrameBuffer for Chromium OS using CameraBufferManager
* CameraBufferManager
*/ */
#include <memory> #include <memory>

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2021, Google Inc. * Copyright (C) 2021, Google Inc.
* *
* generic_camera_buffer.cpp - Allocate FrameBuffer using gralloc API * Allocate FrameBuffer using gralloc API
*/ */
#include <dlfcn.h> #include <dlfcn.h>

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2022, Ideas on Board Oy * Copyright (C) 2022, Ideas on Board Oy
* *
* sdl_sink.h - SDL Sink * SDL Sink
*/ */
#include "sdl_sink.h" #include "sdl_sink.h"

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2023, Ideas on Board Oy * Copyright (C) 2023, Ideas on Board Oy
* *
* ipa_verify.cpp - Verify signature on an IPA module * Verify signature on an IPA module
*/ */
#include <iostream> #include <iostream>

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2020-2021, Google Inc. * Copyright (C) 2020-2021, Google Inc.
* *
* simple_capture.cpp - Simple capture helper * Simple capture helper
*/ */
#include "capture.h" #include "capture.h"

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2020-2021, Google Inc. * Copyright (C) 2020-2021, Google Inc.
* *
* simple_capture.h - Simple capture helper * Simple capture helper
*/ */
#pragma once #pragma once

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2019, Google Inc. * Copyright (C) 2019, Google Inc.
* *
* format_convert.cpp - qcam - Convert buffer to RGB * Convert buffer to RGB
*/ */
#include "format_converter.h" #include "format_converter.h"

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2019, Google Inc. * Copyright (C) 2019, Google Inc.
* *
* format_convert.h - qcam - Convert buffer to RGB * Convert buffer to RGB
*/ */
#pragma once #pragma once

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2020, Laurent Pinchart <laurent.pinchart@ideasonboard.com> * Copyright (C) 2020, Laurent Pinchart <laurent.pinchart@ideasonboard.com>
* *
* message_handler.cpp - qcam - Log message handling * Log message handling
*/ */
#pragma once #pragma once

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2020, Linaro * Copyright (C) 2020, Linaro
* *
* viewfinderGL.cpp - OpenGL Viewfinder for rendering by OpenGL shader * OpenGL Viewfinder for rendering by OpenGL shader
*/ */
#include "viewfinder_gl.h" #include "viewfinder_gl.h"

View file

@ -2,8 +2,7 @@
/* /*
* Copyright (C) 2020, Linaro * Copyright (C) 2020, Linaro
* *
* viewfinder_GL.h - OpenGL Viewfinder for rendering by OpenGL shader * OpenGL Viewfinder for rendering by OpenGL shader
*
*/ */
#pragma once #pragma once

View file

@ -3,7 +3,7 @@
* Copyright (C) 2020, Collabora Ltd. * Copyright (C) 2020, Collabora Ltd.
* Author: Nicolas Dufresne <nicolas.dufresne@collabora.com> * Author: Nicolas Dufresne <nicolas.dufresne@collabora.com>
* *
* gstlibcamera-utils.c - GStreamer libcamera Utility Function * GStreamer libcamera Utility Function
*/ */
#include "gstlibcamera-utils.h" #include "gstlibcamera-utils.h"

View file

@ -3,7 +3,7 @@
* Copyright (C) 2019, Collabora Ltd. * Copyright (C) 2019, Collabora Ltd.
* Author: Nicolas Dufresne <nicolas.dufresne@collabora.com> * Author: Nicolas Dufresne <nicolas.dufresne@collabora.com>
* *
* gstlibcamera.c - GStreamer plugin * GStreamer plugin
*/ */
#include "gstlibcameraprovider.h" #include "gstlibcameraprovider.h"

View file

@ -3,7 +3,7 @@
* Copyright (C) 2020, Collabora Ltd. * Copyright (C) 2020, Collabora Ltd.
* Author: Nicolas Dufresne <nicolas.dufresne@collabora.com> * Author: Nicolas Dufresne <nicolas.dufresne@collabora.com>
* *
* gstlibcameraprovider.c - GStreamer Device Provider * GStreamer Device Provider
*/ */
#include <array> #include <array>

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2021, Ideas On Board * Copyright (C) 2021, Ideas On Board
* *
* ipu3_agc.cpp - AGC/AEC mean-based control algorithm * AGC/AEC mean-based control algorithm
*/ */
#include "agc.h" #include "agc.h"

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2021, Google inc. * Copyright (C) 2021, Google inc.
* *
* black_correction.h - IPU3 Black Level Correction control * IPU3 Black Level Correction control
*/ */
#pragma once #pragma once

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2021, Raspberry Pi Ltd * Copyright (C) 2021, Raspberry Pi Ltd
* *
* denoise.h - Denoise control algorithm interface * Denoise control algorithm interface
*/ */
#pragma once #pragma once

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2022 Raspberry Pi Ltd * Copyright (C) 2022 Raspberry Pi Ltd
* *
* Denoise.cpp - Denoise (spatial, colour, temporal) control algorithm * Denoise (spatial, colour, temporal) control algorithm
*/ */
#include "denoise.h" #include "denoise.h"

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2022 Raspberry Pi Ltd * Copyright (C) 2022 Raspberry Pi Ltd
* *
* hdr.h - Tonemap control algorithm status * Tonemap control algorithm status
*/ */
#pragma once #pragma once

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2019-2021, Raspberry Pi Ltd * Copyright (C) 2019-2021, Raspberry Pi Ltd
* *
* rpi.cpp - Raspberry Pi VC4/BCM2835 ISP IPA. * Raspberry Pi VC4/BCM2835 ISP IPA.
*/ */
#include <string.h> #include <string.h>

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2021, Ideas on Board Oy * Copyright (C) 2021, Ideas on Board Oy
* *
* backtrace.h - Call stack backtraces * Call stack backtraces
*/ */
#include <libcamera/base/backtrace.h> #include <libcamera/base/backtrace.h>

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2018, Google Inc. * Copyright (C) 2018, Google Inc.
* *
* camera_manager.h - Camera management * Camera management
*/ */
#include "libcamera/internal/camera_manager.h" #include "libcamera/internal/camera_manager.h"

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2020, Raspberry Pi Ltd * Copyright (C) 2020, Raspberry Pi Ltd
* *
* delayed_controls.h - Helper to deal with controls that take effect with a delay * Helper to deal with controls that take effect with a delay
*/ */
#include "libcamera/internal/delayed_controls.h" #include "libcamera/internal/delayed_controls.h"

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2020, Google Inc. * Copyright (C) 2020, Google Inc.
* *
* rkisp1path.cpp - Rockchip ISP1 path helper * Rockchip ISP1 path helper
*/ */
#include "rkisp1_path.h" #include "rkisp1_path.h"

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2020, Google Inc. * Copyright (C) 2020, Google Inc.
* *
* rkisp1path.h - Rockchip ISP1 path helper * Rockchip ISP1 path helper
*/ */
#pragma once #pragma once

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2020, Google Inc. * Copyright (C) 2020, Google Inc.
* *
* v4l2_camera_file.h - V4L2 compatibility camera file information * V4L2 compatibility camera file information
*/ */
#include "v4l2_camera_file.h" #include "v4l2_camera_file.h"

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2020, Sebastian Fricke * Copyright (C) 2020, Sebastian Fricke
* *
* bayer_format.cpp - BayerFormat class tests * BayerFormat class tests
*/ */
#include <iostream> #include <iostream>

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2018, Google Inc. * Copyright (C) 2018, Google Inc.
* *
* byte_stream_buffer.cpp - ByteStreamBuffer tests * ByteStreamBuffer tests
*/ */
#include <array> #include <array>

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2019, Google Inc. * Copyright (C) 2019, Google Inc.
* *
* control_info.cpp - ControlInfoMap tests * ControlInfoMap tests
*/ */
#include <iostream> #include <iostream>

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2023, Umang Jain <umang.jain@ideasonboard.com> * Copyright (C) 2023, Umang Jain <umang.jain@ideasonboard.com>
* *
* gstreamer_single_stream_test.cpp - GStreamer single stream capture test * GStreamer single stream capture test
*/ */
#include <vector> #include <vector>

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2021, Vedant Paranjape * Copyright (C) 2021, Vedant Paranjape
* *
* gstreamer_test.cpp - GStreamer test base class * GStreamer test base class
*/ */
#pragma once #pragma once

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2019, Google Inc. * Copyright (C) 2019, Google Inc.
* *
* log.cpp - log API test * log API test
*/ */
#include <algorithm> #include <algorithm>

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2020, Google Inc. * Copyright (C) 2020, Google Inc.
* *
* object.cpp - Object deletion tests * Object deletion tests
*/ */
#include <iostream> #include <iostream>

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2019, Google Inc. * Copyright (C) 2019, Google Inc.
* *
* shared_fd.cpp - SharedFD test * SharedFD test
*/ */
#include <fcntl.h> #include <fcntl.h>

View file

@ -2,7 +2,7 @@
/* /*
* Copyright (C) 2018, Google Inc. * Copyright (C) 2018, Google Inc.
* *
* vl42device_test.h - libcamera v4l2device test base class * libcamera v4l2device test base class
*/ */
#pragma once #pragma once

View file

@ -4,7 +4,7 @@
# #
# Author: Laurent Pinchart <laurent.pinchart@ideasonboard.com> # Author: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
# #
# ipa-gen-key.py - Generate the IPA module signing public key # Generate the IPA module signing public key
import string import string
import subprocess import subprocess

View file

@ -4,8 +4,7 @@
# #
# Author: Laurent Pinchart <laurent.pinchart@ideasonboard.com> # Author: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
# #
# rkisp-capture.sh - Capture processed frames from cameras based on the # Capture processed frames from cameras based on the Rockchip ISP1
# Rockchip ISP1
# #
# The scripts makes use of the following tools, which are expected to be # The scripts makes use of the following tools, which are expected to be
# executable from the system-wide path or from the local directory: # executable from the system-wide path or from the local directory: