From 4504fcc8270857040fc1f53477d80f635310d52b Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Sat, 15 Apr 2017 21:22:19 +0200 Subject: [PATCH] added file headers with author and copyright info --- include/villas/crypt.h | 6 ++++++ include/villas/json.h | 5 +++++ include/villas/nodes/shmem.h | 13 +++++++++++++ include/villas/queue_signalled.h | 7 +++++++ include/villas/shmem.h | 7 ++++++- lib/crypt.c | 5 +++++ lib/json.c | 6 ++++++ lib/nodes/shmem.c | 6 ++++++ lib/queue_signalled.c | 7 ++++++- lib/shmem.c | 7 +++++++ src/shmem.c | 11 ++++++++--- 11 files changed, 75 insertions(+), 5 deletions(-) diff --git a/include/villas/crypt.h b/include/villas/crypt.h index d9f168f88..e1ef47b7c 100644 --- a/include/villas/crypt.h +++ b/include/villas/crypt.h @@ -1,3 +1,9 @@ +/** Crypto helpers. + * + * @author Steffen Vogel + * @copyright 2017, Institute for Automation of Complex Power Systems, EONERC + *********************************************************************************/ + #pragma once #include diff --git a/include/villas/json.h b/include/villas/json.h index 868f007ce..9f0fb3b9f 100644 --- a/include/villas/json.h +++ b/include/villas/json.h @@ -1,4 +1,9 @@ #pragma once +/** JSON serializtion of various objects. + * + * @author Steffen Vogel + * @copyright 2017, Institute for Automation of Complex Power Systems, EONERC + *********************************************************************************/ #ifdef WITH_JANSSON diff --git a/include/villas/nodes/shmem.h b/include/villas/nodes/shmem.h index 0ea273dc3..83df54adf 100644 --- a/include/villas/nodes/shmem.h +++ b/include/villas/nodes/shmem.h @@ -1,5 +1,18 @@ #ifndef _SHMEM_H_ #define _SHMEM_H_ +/** Node-type for shared memory communication. + * + * @file + * @author Georg Martin Reinke + * @copyright 2017, Institute for Automation of Complex Power Systems, EONERC + *********************************************************************************/ + +/** + * @ingroup node + * @addtogroup shmem Shared memory interface + * @{ + */ + #include "node.h" #include "memory.h" diff --git a/include/villas/queue_signalled.h b/include/villas/queue_signalled.h index 84acb8909..27baebbd9 100644 --- a/include/villas/queue_signalled.h +++ b/include/villas/queue_signalled.h @@ -1,3 +1,10 @@ +/** Wrapper around queue that uses POSIX CV's for signalling writes. + * + * @file + * @author Georg Martin Reinke + * @copyright 2017, Institute for Automation of Complex Power Systems, EONERC + *********************************************************************************/ + #pragma once #include diff --git a/include/villas/shmem.h b/include/villas/shmem.h index 93da15a72..9ab8b05eb 100644 --- a/include/villas/shmem.h +++ b/include/villas/shmem.h @@ -1,6 +1,11 @@ #pragma once +/** Shared-memory interface: The interface functions that the external program should use. + * + * @file + * @author Georg Martin Reinke + * @copyright 2017, Institute for Automation of Complex Power Systems, EONERC + *********************************************************************************/ -/* The interface functions that the external program should use. */ #include "pool.h" #include "queue.h" diff --git a/lib/crypt.c b/lib/crypt.c index f7282e4eb..2831e945e 100644 --- a/lib/crypt.c +++ b/lib/crypt.c @@ -1,4 +1,9 @@ #include "crypt.h" +/** Crypto helpers. + * + * @author Steffen Vogel + * @copyright 2017, Institute for Automation of Complex Power Systems, EONERC + *********************************************************************************/ #include diff --git a/lib/json.c b/lib/json.c index 16a1dc1b7..75cb5f4fe 100644 --- a/lib/json.c +++ b/lib/json.c @@ -1,3 +1,9 @@ +/** JSON serializtion of various objects. + * + * @author Steffen Vogel + * @copyright 2017, Institute for Automation of Complex Power Systems, EONERC + *********************************************************************************/ + #include "json.h" #ifdef WITH_JANSSON diff --git a/lib/nodes/shmem.c b/lib/nodes/shmem.c index 9246608cf..5a42f5150 100644 --- a/lib/nodes/shmem.c +++ b/lib/nodes/shmem.c @@ -1,3 +1,9 @@ +/** Node-type for shared memory communication. + * + * @author Georg Martin Reinke + * @copyright 2017, Institute for Automation of Complex Power Systems, EONERC + *********************************************************************************/ + #include #include #include diff --git a/lib/queue_signalled.c b/lib/queue_signalled.c index 0d0706fdd..5e0c59a1b 100644 --- a/lib/queue_signalled.c +++ b/lib/queue_signalled.c @@ -1,4 +1,9 @@ -/** Wrapper around queue that uses POSIX CV's for signalling writes. */ +/** Wrapper around queue that uses POSIX CV's for signalling writes. + * + * @file + * @author Georg Martin Reinke + * @copyright 2017, Institute for Automation of Complex Power Systems, EONERC + *********************************************************************************/ #include "queue_signalled.h" diff --git a/lib/shmem.c b/lib/shmem.c index 70c491f0c..c796a05f8 100644 --- a/lib/shmem.c +++ b/lib/shmem.c @@ -1,3 +1,10 @@ +/** Shared-memory interface: The interface functions that the external program should use. + * + * @file + * @author Georg Martin Reinke + * @copyright 2017, Institute for Automation of Complex Power Systems, EONERC + *********************************************************************************/ + #include #include #include diff --git a/src/shmem.c b/src/shmem.c index 3f98868cc..33f349020 100644 --- a/src/shmem.c +++ b/src/shmem.c @@ -1,6 +1,11 @@ -/* Test "client" for the shared memory interface. - * Busy waits on the incoming queue, prints received samples and writes them - * back to the other queue. */ +/** Test "client" for the shared memory interface. + * + * Waits on the incoming queue, prints received samples and writes them + * back to the other queue. + * + * @author Georg Martin Reinke + * @copyright 2017, Institute for Automation of Complex Power Systems, EONERC + *********************************************************************************/ #include "config.h" #include "log.h"