626172a16b
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 block.
The change was generated with the following script:
----------------------------------------
dirs="include/libcamera src test utils"
declare -rA patterns=(
['c']=' \* '
['cpp']=' \* '
['h']=' \* '
['py']='# '
['sh']='# '
)
for ext in ${!patterns[@]} ; do
files=$(for dir in $dirs ; do find $dir -name "*.${ext}" ; done)
pattern=${patterns[${ext}]}
for file in $files ; do
name=$(basename ${file})
sed -i "s/^\(${pattern}\)${name} - /\1/" "$file"
done
done
----------------------------------------
This misses several files that are out of sync with the comment block
header. Those will be addressed separately and manually.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
46 lines
1.2 KiB
C++
46 lines
1.2 KiB
C++
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2019, Google Inc.
|
|
*
|
|
* Control validator
|
|
*/
|
|
|
|
#include "libcamera/internal/control_validator.h"
|
|
|
|
/**
|
|
* \file control_validator.h
|
|
* \brief Abstract control validator
|
|
*/
|
|
|
|
namespace libcamera {
|
|
|
|
/**
|
|
* \class ControlValidator
|
|
* \brief Interface for the control validator
|
|
*
|
|
* The ControlValidator class is used by the ControlList class to validate
|
|
* controls added to the list. It is an abstract class providing an interface
|
|
* for object-specific control validation, such a Camera controls and V4L2
|
|
* controls.
|
|
*/
|
|
|
|
/**
|
|
* \fn ControlValidator::name()
|
|
* \brief Retrieve the name of the object associated with the validator
|
|
* \return The name of the object associated with the validator
|
|
*/
|
|
|
|
/**
|
|
* \fn ControlValidator::validate()
|
|
* \brief Validate a control
|
|
* \param[in] id The control ID
|
|
*
|
|
* This function validates the control \a id against the object corresponding to
|
|
* the validator. It shall at least validate that the control is applicable to
|
|
* the object instance, and may perform additional checks.
|
|
*
|
|
* \return True if the control is valid, false otherwise
|
|
*/
|
|
|
|
} /* namespace libcamera */
|