Message ID | 20201223174535.23977-1-laurent.pinchart@ideasonboard.com |
---|---|
State | Accepted |
Delegated to: | Laurent Pinchart |
Headers | show |
Series |
|
Related | show |
Hi Laurent, Thanks for dealing with Doxygen. On 2020-12-23 19:45:35 +0200, Laurent Pinchart wrote: > The Doxygen documentation for enumerators of the ConnectionType > enumeration prefixes the enumerator name with the enumeration name. For > unscoped enumerations, this is incorrect. Drop the scope. This fixes > warnings produced by Doxygen when multiple enumerators with identical > names are defined in different scopes. > > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se> > --- > src/libcamera/bound_method.cpp | 8 ++++---- > 1 file changed, 4 insertions(+), 4 deletions(-) > > diff --git a/src/libcamera/bound_method.cpp b/src/libcamera/bound_method.cpp > index 9993e5969aac..4965bb5e167b 100644 > --- a/src/libcamera/bound_method.cpp > +++ b/src/libcamera/bound_method.cpp > @@ -26,22 +26,22 @@ namespace libcamera { > * between a sender and a receiver. It applies to Signal::emit() and > * Object::invokeMethod(). > * > - * \var ConnectionType::ConnectionTypeAuto > + * \var ConnectionTypeAuto > * \brief If the sender and the receiver live in the same thread, > * ConnectionTypeDirect is used. Otherwise ConnectionTypeQueued is used. > * > - * \var ConnectionType::ConnectionTypeDirect > + * \var ConnectionTypeDirect > * \brief The receiver is invoked immediately and synchronously in the sender's > * thread. > * > - * \var ConnectionType::ConnectionTypeQueued > + * \var ConnectionTypeQueued > * \brief The receiver is invoked asynchronously > * > * Invoke the receiver asynchronously in its thread when control returns to the > * thread's event loop. The sender proceeds without waiting for the invocation > * to complete. > * > - * \var ConnectionType::ConnectionTypeBlocking > + * \var ConnectionTypeBlocking > * \brief The receiver is invoked synchronously > * > * If the sender and the receiver live in the same thread, this is equivalent to > -- > Regards, > > Laurent Pinchart > > _______________________________________________ > libcamera-devel mailing list > libcamera-devel@lists.libcamera.org > https://lists.libcamera.org/listinfo/libcamera-devel
diff --git a/src/libcamera/bound_method.cpp b/src/libcamera/bound_method.cpp index 9993e5969aac..4965bb5e167b 100644 --- a/src/libcamera/bound_method.cpp +++ b/src/libcamera/bound_method.cpp @@ -26,22 +26,22 @@ namespace libcamera { * between a sender and a receiver. It applies to Signal::emit() and * Object::invokeMethod(). * - * \var ConnectionType::ConnectionTypeAuto + * \var ConnectionTypeAuto * \brief If the sender and the receiver live in the same thread, * ConnectionTypeDirect is used. Otherwise ConnectionTypeQueued is used. * - * \var ConnectionType::ConnectionTypeDirect + * \var ConnectionTypeDirect * \brief The receiver is invoked immediately and synchronously in the sender's * thread. * - * \var ConnectionType::ConnectionTypeQueued + * \var ConnectionTypeQueued * \brief The receiver is invoked asynchronously * * Invoke the receiver asynchronously in its thread when control returns to the * thread's event loop. The sender proceeds without waiting for the invocation * to complete. * - * \var ConnectionType::ConnectionTypeBlocking + * \var ConnectionTypeBlocking * \brief The receiver is invoked synchronously * * If the sender and the receiver live in the same thread, this is equivalent to
The Doxygen documentation for enumerators of the ConnectionType enumeration prefixes the enumerator name with the enumeration name. For unscoped enumerations, this is incorrect. Drop the scope. This fixes warnings produced by Doxygen when multiple enumerators with identical names are defined in different scopes. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> --- src/libcamera/bound_method.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)