From 106cb9437986649ab6d1bce1d24dacd92720268e Mon Sep 17 00:00:00 2001 From: Pavel Kirienko Date: Sat, 9 May 2015 12:35:18 +0300 Subject: [PATCH] Added a README explaining what's going on --- libuavcan/include/uavcan/protocol/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 libuavcan/include/uavcan/protocol/README.md diff --git a/libuavcan/include/uavcan/protocol/README.md b/libuavcan/include/uavcan/protocol/README.md new file mode 100644 index 0000000000..1b29688f36 --- /dev/null +++ b/libuavcan/include/uavcan/protocol/README.md @@ -0,0 +1,13 @@ +High-level protocol logic +========================= + +Classes defined in this directory implement some high-level functions of UAVCAN. + +Since most applications won't use all of them at the same time, their definitions are provided right in the header +files rather than in source files, in order to not pollute the build outputs with unused code (which is also a +requirement for most safety-critical software). + +However, some of the high-level functions that are either always used by the library itself or those that are extremely +likely to be used by the application are defined in .cpp files. + +When adding a new class here, please think twice before putting its definition into a .cpp file.