NekoCWD/libcamera
NekoCWD/libcamera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 7 Wiki Activity Actions

libcamera: Drop file name from header comment blocks in templates

Browse source 
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
template files and templates embedded in generator scripts.

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 f1522e94df
commit 829acb3ab0
16 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

2
utils/gen-header.sh
View file

@ -9,7 +9,7 @@ cat <<EOF > "$dst_file"
/*
* Copyright (C) 2018-2019, Google Inc.
*
* libcamera.h - libcamera public API
* libcamera public API
*/
#pragma once

2
utils/ipc/extract-docs.py
View file

@ -38,7 +38,7 @@ def main(argv):
/*
* Copyright (C) 2021, Google Inc.
*
* {pipeline}_ipa_interface.cpp - Docs file for generated {pipeline}.mojom
* Docs file for generated {pipeline}.mojom
*
* This file is auto-generated. Do not edit.
*/

2
utils/ipc/generators/libcamera_templates/core_ipa_interface.h.tmpl
View file

@ -7,7 +7,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* core_ipa_interface.h - libcamera core definitions for Image Processing Algorithms
* libcamera core definitions for Image Processing Algorithms
*
* This file is auto-generated. Do not edit.
*/

2
utils/ipc/generators/libcamera_templates/core_ipa_serializer.h.tmpl
View file

@ -8,7 +8,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* core_ipa_serializer.h - Data serializer for core libcamera definitions for IPA
* Data serializer for core libcamera definitions for IPA
*
* This file is auto-generated. Do not edit.
*/

2
utils/ipc/generators/libcamera_templates/module_ipa_interface.h.tmpl
View file

@ -7,7 +7,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* {{module_name}}_ipa_interface.h - Image Processing Algorithm interface for {{module_name}}
* Image Processing Algorithm interface for {{module_name}}
*
* This file is auto-generated. Do not edit.
*/

2
utils/ipc/generators/libcamera_templates/module_ipa_proxy.cpp.tmpl
View file

@ -8,7 +8,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* {{module_name}}_ipa_proxy.cpp - Image Processing Algorithm proxy for {{module_name}}
* Image Processing Algorithm proxy for {{module_name}}
*
* This file is auto-generated. Do not edit.
*/

2
utils/ipc/generators/libcamera_templates/module_ipa_proxy.h.tmpl
View file

@ -8,7 +8,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* {{module_name}}_ipa_proxy.h - Image Processing Algorithm proxy for {{module_name}}
* Image Processing Algorithm proxy for {{module_name}}
*
* This file is auto-generated. Do not edit.
*/

2
utils/ipc/generators/libcamera_templates/module_ipa_proxy_worker.cpp.tmpl
View file

@ -8,7 +8,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* {{module_name}}_ipa_proxy_worker.cpp - Image Processing Algorithm proxy worker for {{module_name}}
* Image Processing Algorithm proxy worker for {{module_name}}
*
* This file is auto-generated. Do not edit.
*/

2
utils/ipc/generators/libcamera_templates/module_ipa_serializer.h.tmpl
View file

@ -8,7 +8,7 @@
/*
* Copyright (C) 2020, Google Inc.
*
* {{module_name}}_ipa_serializer.h - Image Processing Algorithm data serializer for {{module_name}}
* Image Processing Algorithm data serializer for {{module_name}}
*
* This file is auto-generated. Do not edit.
*/