summaryrefslogtreecommitdiff
path: root/daemons/gptp/common/avbts_osipc.hpp
diff options
context:
space:
mode:
authorDavid Cemin <david.cemin@coveloz.com>2015-05-14 17:48:00 -0400
committerDavid Cemin <david.cemin@coveloz.com>2015-05-14 17:48:00 -0400
commit42aec8fa9e6b6ac3562257766018e21c9ac6d92b (patch)
treea9f6fe43a35a2511be48d2ecb496137a95df8714 /daemons/gptp/common/avbts_osipc.hpp
parent03752dd80a3e018f56fedc342e3b86c688d25773 (diff)
downloadOpen-AVB-42aec8fa9e6b6ac3562257766018e21c9ac6d92b.tar.gz
[gPTP doc] Fixing warnings
Diffstat (limited to 'daemons/gptp/common/avbts_osipc.hpp')
-rw-r--r--daemons/gptp/common/avbts_osipc.hpp10
1 files changed, 7 insertions, 3 deletions
diff --git a/daemons/gptp/common/avbts_osipc.hpp b/daemons/gptp/common/avbts_osipc.hpp
index b605e002..65ec0267 100644
--- a/daemons/gptp/common/avbts_osipc.hpp
+++ b/daemons/gptp/common/avbts_osipc.hpp
@@ -38,7 +38,9 @@
#include <ptptypes.hpp>
#include <avbts_port.hpp>
-/*
+/**@file*/
+
+/**
* Generic interface for Inter Process Communication arguments
*/
class OS_IPC_ARG {
@@ -48,7 +50,7 @@ public:
inline OS_IPC_ARG::~OS_IPC_ARG () { }
-/*
+/**
* Generic interface for Inter Process Communication
*/
class OS_IPC {
@@ -64,13 +66,15 @@ public:
* @param ml_phoffset Master to local phase offset
* @param ls_phoffset Local to slave phase offset
* @param ml_freqoffset Master to local frequency offset
+ * @param ls_freq_offset Local to slave frequency offset
+ * @param local_time Local time
* @param sync_count Count of syncs
* @param pdelay_count Count of pdelays
* @param port_state Port's state
* @return Implementation dependent.
*/
virtual bool update
- ( int64_t ml_phoffset, int64_t ls_phoffset,
+ ( int64_t ml_phoffset, int64_t ls_phoffset,
FrequencyRatio ml_freqoffset, FrequencyRatio ls_freq_offset,
uint64_t local_time, uint32_t sync_count, uint32_t pdelay_count,
PortState port_state ) = 0;