Skip to content

Commit

Permalink
[doc] Make @file tags match the actual filenames
Browse files Browse the repository at this point in the history
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 <simo.piiroinen@jollamobile.com>
  • Loading branch information
spiiroin committed Feb 23, 2018
1 parent 550ced2 commit 9d54f37
Show file tree
Hide file tree
Showing 21 changed files with 28 additions and 28 deletions.
4 changes: 2 additions & 2 deletions 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
<p>
Copyright (C) 2009-2010 Nokia Corporation
Expand Down
2 changes: 1 addition & 1 deletion adaptors/alsadaptor-evdev/alsevdevadaptor.h
@@ -1,5 +1,5 @@
/**
@file inputdevadaptor.cpp
@file alsevdevadaptor.h
@brief Contains ALSAdaptorEvdev.
<p>
Expand Down
2 changes: 1 addition & 1 deletion adaptors/alsadaptor-sysfs/alsadaptor-sysfsplugin.cpp
@@ -1,5 +1,5 @@
/**
@file alsadaptorplugin-sysfs.cpp
@file alsadaptor-sysfsplugin.cpp
@brief Plugin for ALSAdaptorSysfs
<p>
Expand Down
4 changes: 2 additions & 2 deletions 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
<p>
Copyright (C) 2009-2010 Nokia Corporation
Expand Down
@@ -1,6 +1,6 @@
/**
@file alsadaptor-sysfsplugin.h
@brief Plugin for ALSAdaptorSysfs
@file magnetometeradaptor-evdevplugin.h
@brief Plugin for MagnetometerAdaptorEvdev
<p>
Copyright (C) 2009-2010 Nokia Corporation
Expand Down
2 changes: 1 addition & 1 deletion chains/orientationchain/orientationchainplugin.cpp
@@ -1,5 +1,5 @@
/**
@file accelerometerchainplugin.cpp
@file orientationchainplugin.cpp
@brief Plugin for AccelerometerChain
<p>
Expand Down
4 changes: 2 additions & 2 deletions chains/orientationchain/orientationchainplugin.h
@@ -1,6 +1,6 @@
/**
@file accelerometerchainplugin.h
@brief Plugin for AccelerometerChain
@file orientationchainplugin.h
@brief Plugin for OrientationChain
<p>
Copyright (C) 2009-2010 Nokia Corporation
Expand Down
2 changes: 1 addition & 1 deletion examples/sensorplugin/samplesensor_a.cpp
@@ -1,5 +1,5 @@
/**
@file accelerometersensor_a.cpp
@file samplesensor_a.cpp
@brief Sample D-Bus adaptor for sensors
<p>
Expand Down
@@ -1,6 +1,6 @@
/**
@file MagCoordinateAlignFilterPlugin.cpp
@brief Plugin for CoordinateAlignFilter
@file magcoordinatealignfilterplugin.cpp
@brief Plugin for MagCoordinateAlignFilter
<p>
Copyright (C) 2009-2010 Nokia Corporation
Expand Down
@@ -1,6 +1,6 @@
/**
@file coordinatealignfilterplugin.h
@brief Plugin for CoordinateAlignFilter
@file magcoordinatealignfilterplugin.h
@brief Plugin for MagCoordinateAlignFilter
<p>
Copyright (C) 2009-2010 Nokia Corporation
Expand Down
2 changes: 1 addition & 1 deletion filters/rotationfilter/rotationfilterplugin.cpp
@@ -1,5 +1,5 @@
/**
@file rotationfilterplugin.cppp
@file rotationfilterplugin.cpp
@brief Plugin for RotationFilter
<p>
Expand Down
4 changes: 2 additions & 2 deletions 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
<p>
Copyright (C) 2016 Canonical, Ltd.
Expand Down
2 changes: 1 addition & 1 deletion sensors/contextplugin/stabilitybin.cpp
@@ -1,5 +1,5 @@
/**
@file stabilitybin.h
@file stabilitybin.cpp
@brief Stability Bin for ContextFW
<p>
Copyright (C) 2009-2010 Nokia Corporation
Expand Down
2 changes: 1 addition & 1 deletion sensors/humiditysensor/humidityplugin.cpp
@@ -1,5 +1,5 @@
/**
@file HumidityPlugin.cpp
@file humidityplugin.cpp
@brief Plugin for HumiditySensor
<p>
Expand Down
2 changes: 1 addition & 1 deletion sensors/lidsensor/lidplugin.cpp
@@ -1,5 +1,5 @@
/**
@file LidPlugin.cpp
@file lidplugin.cpp
@brief Plugin for LidSensor
<p>
Expand Down
2 changes: 1 addition & 1 deletion sensors/pressuresensor/pressureplugin.cpp
@@ -1,5 +1,5 @@
/**
@file PressurePlugin.cpp
@file pressureplugin.cpp
@brief Plugin for PressureSensor
<p>
Expand Down
2 changes: 1 addition & 1 deletion tests/deadclient/datareceiver.h
@@ -1,5 +1,5 @@
/**
@file deadclient.h
@file datareceiver.h
@brief Automatic tests for dead client handling
<p>
Copyright (C) 2009-2010 Nokia Corporation
Expand Down
2 changes: 1 addition & 1 deletion tests/testapp/sensorhandler_qtapi.cpp
@@ -1,5 +1,5 @@
/**
@file sensorhandler.cpp
@file sensorhandler_qtapi.cpp
@brief sensor handler
<p>
Copyright (C) 2010-2011 Nokia Corporation
Expand Down
2 changes: 1 addition & 1 deletion tests/testapp/sensorhandler_qtapi.h
@@ -1,5 +1,5 @@
/**
@file sensorhandler.h
@file sensorhandler_qtapi.h
@brief test application to create sensor
<p>
Expand Down
2 changes: 1 addition & 1 deletion tests/testapp/sensorhandler_qtmob.cpp
@@ -1,5 +1,5 @@
/**
@file sensorhandler_qmsystem2.cpp
@file sensorhandler_qtmob.cpp
@brief sensor handler
<p>
Copyright (C) 2011 Nokia Corporation
Expand Down
2 changes: 1 addition & 1 deletion tests/testapp/sensorhandler_qtmob.h
@@ -1,5 +1,5 @@
/**
@file sensorhandler_qmsystem2.h
@file sensorhandler_qtmob.h
@brief test application to create sensor
<p>
Expand Down

0 comments on commit 9d54f37

Please sign in to comment.