Some fixes do doxygen

Author: yurii-litvinov

trikCommunicator/include/trikCommunicator/trikCommunicator.h

@@ -45,7 +45,7 @@ class TrikCommunicator : public trikKernel::TrikServer
 
 public:
 	/// Constructor that creates its own instance of a script runner.
-	/// @param configPath - path to config file for trikControl, for example, /home/root/trik/.
+	/// @param brick - reference to robot brick.
 	/// @param startDirPath - path to the directory from which the application was executed.
 	TrikCommunicator(trikControl::Brick &brick, QString const &startDirPath);
 

trikControl/include/trikControl/display.h

@@ -64,8 +64,8 @@ public slots:
 	/// Draw line on the widget.
 	/// @param x1 - first point's x coordinate.
 	/// @param y1 - first point's y coordinate.
-	/// @param x1 - second point's x coordinate.
-	/// @param y1 - second point's y coordinate.
+	/// @param x2 - second point's x coordinate.
+	/// @param y2 - second point's y coordinate.
 	void drawLine(int x1, int y1, int x2, int y2);
 
 	/// Draw point on the widget.

trikControl/include/trikControl/sensor3d.h

@@ -37,9 +37,10 @@ class TRIKCONTROL_EXPORT Sensor3d : public QObject
 	/// @param deviceFile - device file for this sensor.
 	Sensor3d(int min, int max, QString const &deviceFile);
 
-	~Sensor3d();
+	~Sensor3d() override;
 
 signals:
+	/// Emitted when new sensor reading is ready.
 	void newData(QVector<int> reading);
 
 public slots:

trikControl/src/angularServoMotor.h

@@ -33,6 +33,7 @@ class AngularServoMotor : public ServoMotor
 	/// @param max - value of duty_ns corresponding to full counter clockwise rotation of a motor. Used to calculate
 	///        actual values from values in range [-90..90] from client program.
 	/// @param zero - value of duty_ns corresponding to 0 degrees rotation of a motor.
+	/// @param stop - value of duty_ns corresponding to poweroff state.
 	/// @param dutyFile - file for setting duty of PWM signal supplied to this motor.
 	/// @param periodFile - file for setting period of PWM signal supplied to this motor
 	/// @param period - value of period for setting while initialization

trikControl/src/continiousRotationServoMotor.h

@@ -33,6 +33,7 @@ class ContiniousRotationServoMotor : public ServoMotor
 	/// @param max - value of duty_ns corresponding to full forward of a motor. Used to calculate actual values from
 	///        values in range [-100..100] from client program.
 	/// @param zero - value of duty_ns corresponding to full stop of a motor.
+	/// @param stop - value of duty_ns corresponding to poweroff state.
 	/// @param dutyFile - file for setting duty of PWM signal supplied to this motor.
 	/// @param periodFile - file for setting period of PWM signal supplied to this motor
 	/// @param period - value of period for setting while initialization

trikControl/src/graphicsWidget.h

@@ -50,8 +50,8 @@ class GraphicsWidget : public QWidget
 	/// Draw line on the widget.
 	/// @param x1 - first point's x coordinate.
 	/// @param y1 - first point's y coordinate.
-	/// @param x1 - second point's x coordinate.
-	/// @param y1 - second point's y coordinate.
+	/// @param x2 - second point's x coordinate.
+	/// @param y2 - second point's y coordinate.
 	void drawLine(int x1, int y1, int x2, int y2);
 
 	/// Draw rect on the widget.

trikControl/src/powerMotor.h

@@ -31,11 +31,13 @@ class PowerMotor : public Motor
 
 public:
 	/// Constructor.
+	/// @param communicator - reference to an object that handles I2C communication.
+	/// @param i2cCommandNumber - I2C command corresponding to this device.
 	/// @param invert - true, if power values set by setPower slot shall be negated before sent to motor.
 	PowerMotor(I2cCommunicator &communicator, int i2cCommandNumber, bool invert);
 
 	/// Destructor.
-	~PowerMotor();
+	~PowerMotor() override;
 
 public slots:
 	/// Sets current motor power to specified value, 0 to stop motor.

trikControl/src/sensor3dWorker.h

@@ -35,6 +35,7 @@ class Sensor3dWorker : public QObject
 	Sensor3dWorker(int min, int max, QString const &deviceFile);
 
 signals:
+	/// Emitted when new sensor reading is ready.
 	void newData(QVector<int> reading);
 
 public slots:
@@ -54,4 +55,4 @@ private slots:
 	QReadWriteLock mLock;
 };
 
-}
+}

trikControl/src/servoMotor.h

@@ -32,11 +32,11 @@ class ServoMotor : public Motor
 	/// @param min - minimal value of duty_ns whose meaning and range depends on motor type.
 	/// @param max - maximal value of duty_ns whose meaning and range depends on motor type.
 	/// @param zero - neutral value of duty_ns.
+	/// @param stop - value of duty_ns corresponding to poweroff state.
 	/// @param dutyFile - file for setting duty of PWM signal supplied to this motor.
 	/// @param periodFile - file for setting period of PWM signal supplied to this motor.
 	/// @param period - value of period for setting while initialization.
 	/// @param invert - true, if power values set by setPower slot shall be negated before sent to motor.
-	/// @param isContiniousRotationServo - true, if this servo is continious rotation, false if it is angular.
 	ServoMotor(int min, int max, int zero, int stop, QString const &dutyFile, QString const &periodFile, int period
 			, bool invert);
 

trikGui/startWidget.h

@@ -50,17 +50,17 @@ class StartWidget : public MainWidget
 
 public:
 	/// Constructor
+	/// @param controller - controller object that provides access to underlying runtime.
 	/// @param configPath - full path to configuration files.
-	/// @param startDirPath - path to the directory from which the application was executed.
 	/// @param parent - parent of this widget in Qt object hierarchy.
 	explicit StartWidget(Controller &controller, QString const &configPath, QWidget *parent = 0);
 
-	~StartWidget();
+	~StartWidget() override;
 
 	void renewFocus() override;
 
 private:
-	virtual void keyPressEvent(QKeyEvent *event);
+	void keyPressEvent(QKeyEvent *event) override;
 
 	void launch();