From 9d54f3789e409fb8a4438f1653a5bae59becb4c3 Mon Sep 17 00:00:00 2001 From: Simo Piiroinen Date: Fri, 23 Feb 2018 10:55:48 +0200 Subject: [PATCH] [doc] Make @file tags match the actual filenames There are warnings during documentation generation due to filenames given as @file tags not matching the actual filename - probably because existing source files have been used as a template when generating new sensors etc. Fix every @file tag that does not exactly match the actual filename. Also try to fix @brief tags that look incorrect enough. Signed-off-by: Simo Piiroinen --- adaptors/alsadaptor-evdev/alsadaptor-evdevplugin.cpp | 4 ++-- adaptors/alsadaptor-evdev/alsevdevadaptor.h | 2 +- adaptors/alsadaptor-sysfs/alsadaptor-sysfsplugin.cpp | 2 +- adaptors/gyroscopeadaptor-evdev/gyroadaptor-evdevplugin.h | 4 ++-- .../magnetometeradaptor-evdevplugin.h | 4 ++-- chains/orientationchain/orientationchainplugin.cpp | 2 +- chains/orientationchain/orientationchainplugin.h | 4 ++-- examples/sensorplugin/samplesensor_a.cpp | 2 +- .../magcoordinatealignfilterplugin.cpp | 4 ++-- .../magcoordinatealignfilter/magcoordinatealignfilterplugin.h | 4 ++-- filters/rotationfilter/rotationfilterplugin.cpp | 2 +- qt-api/lidsensor_i.h | 4 ++-- sensors/contextplugin/stabilitybin.cpp | 2 +- sensors/humiditysensor/humidityplugin.cpp | 2 +- sensors/lidsensor/lidplugin.cpp | 2 +- sensors/pressuresensor/pressureplugin.cpp | 2 +- tests/deadclient/datareceiver.h | 2 +- tests/testapp/sensorhandler_qtapi.cpp | 2 +- tests/testapp/sensorhandler_qtapi.h | 2 +- tests/testapp/sensorhandler_qtmob.cpp | 2 +- tests/testapp/sensorhandler_qtmob.h | 2 +- 21 files changed, 28 insertions(+), 28 deletions(-) diff --git a/adaptors/alsadaptor-evdev/alsadaptor-evdevplugin.cpp b/adaptors/alsadaptor-evdev/alsadaptor-evdevplugin.cpp index 6288bb8b..c1bf97ee 100644 --- a/adaptors/alsadaptor-evdev/alsadaptor-evdevplugin.cpp +++ b/adaptors/alsadaptor-evdev/alsadaptor-evdevplugin.cpp @@ -1,6 +1,6 @@ /** - @file alsadaptorplugin-sysfs.cpp - @brief Plugin for ALSAdaptorSysfs + @file alsadaptor-evdevplugin.cpp + @brief Plugin for ALSAdaptorEvdev

Copyright (C) 2009-2010 Nokia Corporation diff --git a/adaptors/alsadaptor-evdev/alsevdevadaptor.h b/adaptors/alsadaptor-evdev/alsevdevadaptor.h index bd47a3d5..c694d88c 100644 --- a/adaptors/alsadaptor-evdev/alsevdevadaptor.h +++ b/adaptors/alsadaptor-evdev/alsevdevadaptor.h @@ -1,5 +1,5 @@ /** - @file inputdevadaptor.cpp + @file alsevdevadaptor.h @brief Contains ALSAdaptorEvdev.

diff --git a/adaptors/alsadaptor-sysfs/alsadaptor-sysfsplugin.cpp b/adaptors/alsadaptor-sysfs/alsadaptor-sysfsplugin.cpp index 648b620d..d4a9f589 100644 --- a/adaptors/alsadaptor-sysfs/alsadaptor-sysfsplugin.cpp +++ b/adaptors/alsadaptor-sysfs/alsadaptor-sysfsplugin.cpp @@ -1,5 +1,5 @@ /** - @file alsadaptorplugin-sysfs.cpp + @file alsadaptor-sysfsplugin.cpp @brief Plugin for ALSAdaptorSysfs

diff --git a/adaptors/gyroscopeadaptor-evdev/gyroadaptor-evdevplugin.h b/adaptors/gyroscopeadaptor-evdev/gyroadaptor-evdevplugin.h index d1ea63b2..7d9628b2 100644 --- a/adaptors/gyroscopeadaptor-evdev/gyroadaptor-evdevplugin.h +++ b/adaptors/gyroscopeadaptor-evdev/gyroadaptor-evdevplugin.h @@ -1,6 +1,6 @@ /** - @file alsadaptor-evdevplugin.h - @brief Plugin for ALSAdaptorEvdevPlugin + @file gyroadaptor-evdevplugin.h + @brief Plugin for GyroAdaptorEvdevPlugin

Copyright (C) 2009-2010 Nokia Corporation diff --git a/adaptors/magnetometeradaptor-evdev/magnetometeradaptor-evdevplugin.h b/adaptors/magnetometeradaptor-evdev/magnetometeradaptor-evdevplugin.h index 3171ede0..ecb9b897 100644 --- a/adaptors/magnetometeradaptor-evdev/magnetometeradaptor-evdevplugin.h +++ b/adaptors/magnetometeradaptor-evdev/magnetometeradaptor-evdevplugin.h @@ -1,6 +1,6 @@ /** - @file alsadaptor-sysfsplugin.h - @brief Plugin for ALSAdaptorSysfs + @file magnetometeradaptor-evdevplugin.h + @brief Plugin for MagnetometerAdaptorEvdev

Copyright (C) 2009-2010 Nokia Corporation diff --git a/chains/orientationchain/orientationchainplugin.cpp b/chains/orientationchain/orientationchainplugin.cpp index 1ae7f4ac..1eb40f79 100644 --- a/chains/orientationchain/orientationchainplugin.cpp +++ b/chains/orientationchain/orientationchainplugin.cpp @@ -1,5 +1,5 @@ /** - @file accelerometerchainplugin.cpp + @file orientationchainplugin.cpp @brief Plugin for AccelerometerChain

diff --git a/chains/orientationchain/orientationchainplugin.h b/chains/orientationchain/orientationchainplugin.h index 8b86f858..4b0fa573 100644 --- a/chains/orientationchain/orientationchainplugin.h +++ b/chains/orientationchain/orientationchainplugin.h @@ -1,6 +1,6 @@ /** - @file accelerometerchainplugin.h - @brief Plugin for AccelerometerChain + @file orientationchainplugin.h + @brief Plugin for OrientationChain

Copyright (C) 2009-2010 Nokia Corporation diff --git a/examples/sensorplugin/samplesensor_a.cpp b/examples/sensorplugin/samplesensor_a.cpp index a6b01e3f..bbba7e84 100644 --- a/examples/sensorplugin/samplesensor_a.cpp +++ b/examples/sensorplugin/samplesensor_a.cpp @@ -1,5 +1,5 @@ /** - @file accelerometersensor_a.cpp + @file samplesensor_a.cpp @brief Sample D-Bus adaptor for sensors

diff --git a/filters/magcoordinatealignfilter/magcoordinatealignfilterplugin.cpp b/filters/magcoordinatealignfilter/magcoordinatealignfilterplugin.cpp index 61a07171..d872af0e 100644 --- a/filters/magcoordinatealignfilter/magcoordinatealignfilterplugin.cpp +++ b/filters/magcoordinatealignfilter/magcoordinatealignfilterplugin.cpp @@ -1,6 +1,6 @@ /** - @file MagCoordinateAlignFilterPlugin.cpp - @brief Plugin for CoordinateAlignFilter + @file magcoordinatealignfilterplugin.cpp + @brief Plugin for MagCoordinateAlignFilter

Copyright (C) 2009-2010 Nokia Corporation diff --git a/filters/magcoordinatealignfilter/magcoordinatealignfilterplugin.h b/filters/magcoordinatealignfilter/magcoordinatealignfilterplugin.h index f9cd4d44..74dca905 100644 --- a/filters/magcoordinatealignfilter/magcoordinatealignfilterplugin.h +++ b/filters/magcoordinatealignfilter/magcoordinatealignfilterplugin.h @@ -1,6 +1,6 @@ /** - @file coordinatealignfilterplugin.h - @brief Plugin for CoordinateAlignFilter + @file magcoordinatealignfilterplugin.h + @brief Plugin for MagCoordinateAlignFilter

Copyright (C) 2009-2010 Nokia Corporation diff --git a/filters/rotationfilter/rotationfilterplugin.cpp b/filters/rotationfilter/rotationfilterplugin.cpp index 79a96e56..a69c4b67 100644 --- a/filters/rotationfilter/rotationfilterplugin.cpp +++ b/filters/rotationfilter/rotationfilterplugin.cpp @@ -1,5 +1,5 @@ /** - @file rotationfilterplugin.cppp + @file rotationfilterplugin.cpp @brief Plugin for RotationFilter

diff --git a/qt-api/lidsensor_i.h b/qt-api/lidsensor_i.h index 56cbc21a..6da53bf6 100644 --- a/qt-api/lidsensor_i.h +++ b/qt-api/lidsensor_i.h @@ -1,6 +1,6 @@ /** - @file alssensor_i.h - @brief Interface for ALSSensor + @file lidsensor_i.h + @brief Interface for LidSensor

Copyright (C) 2016 Canonical, Ltd. diff --git a/sensors/contextplugin/stabilitybin.cpp b/sensors/contextplugin/stabilitybin.cpp index f2c22625..66fedd83 100644 --- a/sensors/contextplugin/stabilitybin.cpp +++ b/sensors/contextplugin/stabilitybin.cpp @@ -1,5 +1,5 @@ /** - @file stabilitybin.h + @file stabilitybin.cpp @brief Stability Bin for ContextFW

Copyright (C) 2009-2010 Nokia Corporation diff --git a/sensors/humiditysensor/humidityplugin.cpp b/sensors/humiditysensor/humidityplugin.cpp index 7baf67c4..ad054e5a 100644 --- a/sensors/humiditysensor/humidityplugin.cpp +++ b/sensors/humiditysensor/humidityplugin.cpp @@ -1,5 +1,5 @@ /** - @file HumidityPlugin.cpp + @file humidityplugin.cpp @brief Plugin for HumiditySensor

diff --git a/sensors/lidsensor/lidplugin.cpp b/sensors/lidsensor/lidplugin.cpp index fa5f7f54..2a729be3 100644 --- a/sensors/lidsensor/lidplugin.cpp +++ b/sensors/lidsensor/lidplugin.cpp @@ -1,5 +1,5 @@ /** - @file LidPlugin.cpp + @file lidplugin.cpp @brief Plugin for LidSensor

diff --git a/sensors/pressuresensor/pressureplugin.cpp b/sensors/pressuresensor/pressureplugin.cpp index 013b3b76..f06017d3 100644 --- a/sensors/pressuresensor/pressureplugin.cpp +++ b/sensors/pressuresensor/pressureplugin.cpp @@ -1,5 +1,5 @@ /** - @file PressurePlugin.cpp + @file pressureplugin.cpp @brief Plugin for PressureSensor

diff --git a/tests/deadclient/datareceiver.h b/tests/deadclient/datareceiver.h index 7df247ae..dc0a106a 100644 --- a/tests/deadclient/datareceiver.h +++ b/tests/deadclient/datareceiver.h @@ -1,5 +1,5 @@ /** - @file deadclient.h + @file datareceiver.h @brief Automatic tests for dead client handling

Copyright (C) 2009-2010 Nokia Corporation diff --git a/tests/testapp/sensorhandler_qtapi.cpp b/tests/testapp/sensorhandler_qtapi.cpp index a2df3b1f..e91ec0eb 100644 --- a/tests/testapp/sensorhandler_qtapi.cpp +++ b/tests/testapp/sensorhandler_qtapi.cpp @@ -1,5 +1,5 @@ /** - @file sensorhandler.cpp + @file sensorhandler_qtapi.cpp @brief sensor handler

Copyright (C) 2010-2011 Nokia Corporation diff --git a/tests/testapp/sensorhandler_qtapi.h b/tests/testapp/sensorhandler_qtapi.h index b1af8a21..1f6b01eb 100644 --- a/tests/testapp/sensorhandler_qtapi.h +++ b/tests/testapp/sensorhandler_qtapi.h @@ -1,5 +1,5 @@ /** - @file sensorhandler.h + @file sensorhandler_qtapi.h @brief test application to create sensor

diff --git a/tests/testapp/sensorhandler_qtmob.cpp b/tests/testapp/sensorhandler_qtmob.cpp index ade3b1d1..28136145 100644 --- a/tests/testapp/sensorhandler_qtmob.cpp +++ b/tests/testapp/sensorhandler_qtmob.cpp @@ -1,5 +1,5 @@ /** - @file sensorhandler_qmsystem2.cpp + @file sensorhandler_qtmob.cpp @brief sensor handler

Copyright (C) 2011 Nokia Corporation diff --git a/tests/testapp/sensorhandler_qtmob.h b/tests/testapp/sensorhandler_qtmob.h index 8d8081c8..d3445684 100644 --- a/tests/testapp/sensorhandler_qtmob.h +++ b/tests/testapp/sensorhandler_qtmob.h @@ -1,5 +1,5 @@ /** - @file sensorhandler_qmsystem2.h + @file sensorhandler_qtmob.h @brief test application to create sensor