aboutsummaryrefslogtreecommitdiff
path: root/src/modules/uavcan/uavcan_main.hpp
diff options
context:
space:
mode:
authorLorenz Meier <lm@inf.ethz.ch>2014-05-07 14:29:30 +0200
committerLorenz Meier <lm@inf.ethz.ch>2014-05-07 14:29:30 +0200
commit973b193261fab69320f25fae68345a60d7678dc8 (patch)
tree0d171ae55ce2d76fb5af6551f28bead5f7604b9e /src/modules/uavcan/uavcan_main.hpp
parentde5bdbb8638b1911e9956b49935071349f32ebb7 (diff)
downloadpx4-firmware-973b193261fab69320f25fae68345a60d7678dc8.tar.gz
px4-firmware-973b193261fab69320f25fae68345a60d7678dc8.tar.bz2
px4-firmware-973b193261fab69320f25fae68345a60d7678dc8.zip
Fixed comments and code style of UAVCAN node
Diffstat (limited to 'src/modules/uavcan/uavcan_main.hpp')
-rw-r--r--src/modules/uavcan/uavcan_main.hpp19
1 files changed, 13 insertions, 6 deletions
diff --git a/src/modules/uavcan/uavcan_main.hpp b/src/modules/uavcan/uavcan_main.hpp
index 8bd660cc5..b27449f1f 100644
--- a/src/modules/uavcan/uavcan_main.hpp
+++ b/src/modules/uavcan/uavcan_main.hpp
@@ -1,7 +1,6 @@
/****************************************************************************
*
- * Copyright (C) 2014 PX4 Development Team. All rights reserved.
- * Author: Pavel Kirienko <pavel.kirienko@gmail.com>
+ * Copyright (c) 2014 PX4 Development Team. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
@@ -37,7 +36,15 @@
#include <uavcan_stm32/uavcan_stm32.hpp>
/**
- * Implements basic functinality of UAVCAN node.
+ * @file uavcan_main.hpp
+ *
+ * Defines basic functinality of UAVCAN node.
+ *
+ * @author Pavel Kirienko <pavel.kirienko@gmail.com>
+ */
+
+/**
+ * A UAVCAN node.
*/
class UavcanNode
{
@@ -49,18 +56,18 @@ public:
typedef uavcan::Node<MemPoolSize> Node;
typedef uavcan_stm32::CanInitHelper<RxQueueLenPerIface> CanInitHelper;
- UavcanNode(uavcan::ICanDriver& can_driver, uavcan::ISystemClock& system_clock)
+ UavcanNode(uavcan::ICanDriver &can_driver, uavcan::ISystemClock &system_clock)
: _node(can_driver, system_clock)
{ }
static int start(uavcan::NodeID node_id, uint32_t bitrate);
- Node& getNode() { return _node; }
+ Node &getNode() { return _node; }
private:
int init(uavcan::NodeID node_id);
int run();
- static UavcanNode* _instance;
+ static UavcanNode *_instance; ///< pointer to the library instance
Node _node;
};