From 3db9c820e55aad1e784bf926e551a7de8dae0cdf Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Sat, 28 Nov 2020 11:16:28 +0100 Subject: sapi: Canonicalize @defgroup and @file comments Adjust group identifier and names to be in line with a common pattern. Use common phrases for the group and file brief descriptions. Update #3706. --- cpukit/sapi/src/version.c | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) (limited to 'cpukit/sapi/src/version.c') diff --git a/cpukit/sapi/src/version.c b/cpukit/sapi/src/version.c index 9c10ff3823..feafe7b935 100644 --- a/cpukit/sapi/src/version.c +++ b/cpukit/sapi/src/version.c @@ -1,14 +1,18 @@ /** * @file * - * @brief Creates the version strings from the various pieces of version - * information. The main version number is part of the build system and is - * stamped into rtems/score/cpuopts.h. The version control key string is - * extracted from the version control tool when the code is being built and is - * updated if it has changed. The key may indicate there are local - * modification. - * * @ingroup RTEMSAPIClassicVersion + * + * @brief This source file contains the implementation of rtems_version(), + * rtems_version_control_key(), rtems_version_major(), rtems_version_minor(), + * and rtems_version_revision(). + * + * The version strings are created from the various pieces of version + * information. The main version number is part of the build system and is + * stamped into . The version control key string is + * extracted from the version control tool when the code is being built and is + * updated if it has changed. It is defined in "version-vc-key.h". The key + * may indicate there are local modification. */ /* -- cgit v1.2.3