From 17518fe393a37781c84d09836256bb1a6256032b Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Tue, 20 Jun 2017 04:35:06 +0200 Subject: doxygen: unify use of \file across the board Considering the various styles and implications found in the sources, edit scores of files to follow the same API doc guidelines around the doxygen grouping and the \file tag. Many files now show a short description in the generated API doc that was so far only available as C comment. The guidelines and reasoning behind it is documented at https://osmocom.org/projects/cellular-infrastructure/wiki/Guidelines_for_API_documentation In some instances, remove file comments and add to the corresponding group instead, to be shared among several files (e.g. bitvec). Change-Id: Ifa70e77e90462b5eb2b0457c70fd25275910c72b --- src/codec/gsm610.c | 4 ++-- src/codec/gsm620.c | 4 ++-- src/codec/gsm660.c | 4 ++-- src/codec/gsm690.c | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) (limited to 'src/codec') diff --git a/src/codec/gsm610.c b/src/codec/gsm610.c index df56583a..d5a21108 100644 --- a/src/codec/gsm610.c +++ b/src/codec/gsm610.c @@ -1,5 +1,5 @@ -/* GSM 06.10 - GSM FR codec */ - +/*! \file gsm610.c + * GSM 06.10 - GSM FR codec. */ /* * (C) 2010 Sylvain Munaut * diff --git a/src/codec/gsm620.c b/src/codec/gsm620.c index 30647480..b1a0b319 100644 --- a/src/codec/gsm620.c +++ b/src/codec/gsm620.c @@ -1,5 +1,5 @@ -/* GSM 06.20 - GSM HR codec */ - +/*! \file gsm620.c + * GSM 06.20 - GSM HR codec. */ /* * (C) 2010 Sylvain Munaut * diff --git a/src/codec/gsm660.c b/src/codec/gsm660.c index 6c9215f4..2f5c6a25 100644 --- a/src/codec/gsm660.c +++ b/src/codec/gsm660.c @@ -1,5 +1,5 @@ -/* GSM 06.60 - GSM EFR Codec */ - +/*! \file gsm660.c + * GSM 06.60 - GSM EFR Codec. */ /* * (C) 2010 Sylvain Munaut * diff --git a/src/codec/gsm690.c b/src/codec/gsm690.c index 74655bf4..1ee74d0b 100644 --- a/src/codec/gsm690.c +++ b/src/codec/gsm690.c @@ -1,5 +1,5 @@ -/* GSM 06.90 - GSM AMR Codec */ - +/*! \file gsm690.c + * GSM 06.90 - GSM AMR Codec. */ /* * (C) 2010 Sylvain Munaut * -- cgit v1.2.3