Resolve "Bug: Clang Diagnostic Documentation"

Closes #150 (closed)

applications/platform/acquisition-server/include/ovasIDriver.h

@@ -18,7 +18,6 @@ enum class EDriverFlag { IsUnstable, IsDeprecated };
 class IDriverContext
 {
 public:
-
 	/**
 	 * \brief Destructor
 	 */
@@ -30,12 +29,14 @@ public:
 	 * \sa Kernel::ILogManager
 	 */
 	virtual Kernel::ILogManager& getLogManager() const = 0;
+
 	/**
 	 * \brief Gets the kernel Configuration Manager
 	 * \return the kernel Configuration Manager
 	 * \sa Kernel::IConfigurationManager
 	 */
 	virtual Kernel::IConfigurationManager& getConfigurationManager() const = 0;
+
 	/**
 	 * \brief Gets connection status
 	 * \return \e true if the driver is connected
@@ -43,6 +44,7 @@ public:
 	 * \sa isStarted
 	 */
 	virtual bool isConnected() const = 0;
+
 	/**
 	 * \brief Gets acquisition status
 	 * \return \e true if acquisition is started
@@ -50,6 +52,7 @@ public:
 	 * \sa isConnected
 	 */
 	virtual bool isStarted() const = 0;
+
 	/**
 	 * \brief Checks if impedance check is required (when available)
 	 * \return \e true if impedance check is required
@@ -60,6 +63,7 @@ public:
 	 * should perform impedance measures while initialized but not yet started.
 	 */
 	virtual bool isImpedanceCheckRequested() const = 0;
+
 	/**
 	 * \brief Gets drift sample count
 	 * \return \e the drift sample count
@@ -77,6 +81,7 @@ public:
 	 *        number of samples it had to send
 	 */
 	virtual int64_t getDriftSampleCount() const = 0;
+
 	/**
 	 * \brief Gets the drift sample count tolerance
 	 * \return \e the drift sample count tolerance
@@ -92,6 +97,7 @@ public:
 	 * better don't correct it.
 	 */
 	virtual int64_t getDriftToleranceSampleCount() const = 0;
+
 	/**
 	 * \brief Gets the suggested drift correction sample count
 	 * \return \e the suggested drift correction sample count
@@ -104,6 +110,7 @@ public:
 	 * on the way of computing the actual value returned by this function.
 	 */
 	virtual int64_t getSuggestedDriftCorrectionSampleCount() const = 0;
+
 	/**
 	 * \brief Corrects a drifting device
 	 * \return \e true in case of success
@@ -142,11 +149,10 @@ public:
 	 *          range depends of the actual driver you are creating).
 	 */
 	virtual bool correctDriftSampleCount(const int64_t nSample) = 0;
+
 	/**
 	 * \brief Sets a fixed latency due to the driver implementation and / or hardware
-	 * \param nSample [in] : the number of samples for the inner latency
-	 * \return \e true in case of success
-	 * \return \e false in case of error
+	 * \param[in] nSample : the number of samples for the inner latency
 	 *
 	 * Some drivers / hardware devices implement processes that delay the
 	 * overall acquisition stream. Such processes include for instance
@@ -169,6 +175,7 @@ public:
 	 * \sa getInnerLatencySampleCount
 	 */
 	virtual void setInnerLatencySampleCount(const int64_t nSample) = 0;
+
 	/**
 	 * \brief Gets the fixed latency due to the driver implementation and / or hardware
 	 * \return \e The inner latency of the driver in sample count
@@ -209,7 +216,6 @@ public:
 class IDriverCallback
 {
 public:
-
 	/**
 	 * \brief Gives new sample buffer
 	 * \param samples [in] : a buffer containing all the samples
@@ -321,7 +327,6 @@ public:
 class IDriver
 {
 public:
-
 	/**
 	 * \brief Constructor
 	 * \param ctx [in] : the driver context
@@ -496,11 +501,9 @@ public:
 	//@}
 
 protected:
-
 	IDriverContext& m_driverCtx; ///< The driver context
 
 private:
-
 	/**
 	 * \brief Default constructor can not be used because a context is needed
 	 */