From 462fa8fc683a0609aaafa9a4c6d815bfad76f7d3 Mon Sep 17 00:00:00 2001 From: Matias Elo Date: Mon, 18 Dec 2023 12:08:46 +0200 Subject: example: improve example application documentations Include short description in Doxygen output for each example application. The documentations are moved to application source files for ease of maintenance. Signed-off-by: Matias Elo Reviewed-by: Tuomas Taipale --- example/hello/odp_hello.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'example/hello') diff --git a/example/hello/odp_hello.c b/example/hello/odp_hello.c index 391406946..3516864b8 100644 --- a/example/hello/odp_hello.c +++ b/example/hello/odp_hello.c @@ -4,10 +4,15 @@ * SPDX-License-Identifier: BSD-3-Clause */ -/* This is a minimal application which demonstrates the startup and shutdown +/** + * @example odp_hello.c + * + * This is a minimal application which demonstrates the startup and shutdown * steps of an ODP application. It can be also used to debug API related * build problems, etc. It does not use helpers to minimize dependency to * anything else than the ODP API header file. + * + * @cond _ODP_HIDE_FROM_DOXYGEN_ */ #include -- cgit v1.2.3 From 17c164b5e2b4b34d942edd3d5f382fcfde8cd741 Mon Sep 17 00:00:00 2001 From: Matias Elo Date: Tue, 2 Jan 2024 11:08:23 +0200 Subject: example: update copyright format Update all example files to use the new shorter copyright format: /* SPDX-License-Identifier: BSD-3-Clause * Copyright (c) */ Signed-off-by: Matias Elo Reviewed-by: Tuomas Taipale --- example/hello/odp_hello.c | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) (limited to 'example/hello') diff --git a/example/hello/odp_hello.c b/example/hello/odp_hello.c index 3516864b8..58cc35502 100644 --- a/example/hello/odp_hello.c +++ b/example/hello/odp_hello.c @@ -1,7 +1,5 @@ -/* Copyright (c) 2016-2018, Linaro Limited - * All rights reserved. - * - * SPDX-License-Identifier: BSD-3-Clause +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright (c) 2016-2018 Linaro Limited */ /** -- cgit v1.2.3