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

9 files changed, 58 insertions, 51 deletions

diff --git a/src/gb/common_vty.c b/src/gb/common_vty.c
index 5848a11c..5de51355 100644
--- a/src/gb/common_vty.c
+++ b/src/gb/common_vty.c
@@ -1,5 +1,7 @@
-/* OpenBSC VTY common helpers */
-/* (C) 2009-2012 by Harald Welte <laforge@gnumonks.org>
+/*! \file common_vty.c
+ * OpenBSC VTY common helpers. */
+/*
+ * (C) 2009-2012 by Harald Welte <laforge@gnumonks.org>
  * (C) 2009-2010 by Holger Hans Peter Freyther
  * All Rights Reserved
  *
diff --git a/src/gb/common_vty.h b/src/gb/common_vty.h
index 8c6b9ab1..a0674a7f 100644
--- a/src/gb/common_vty.h
+++ b/src/gb/common_vty.h
@@ -1,3 +1,5 @@
+/*! \file common_vty.h */
+
 #include <osmocom/vty/command.h>
 #include <osmocom/core/logging.h>
 
diff --git a/src/gb/gprs_bssgp.c b/src/gb/gprs_bssgp.c
index 142f5898..518198fd 100644
--- a/src/gb/gprs_bssgp.c
+++ b/src/gb/gprs_bssgp.c
@@ -1,6 +1,7 @@
-/* GPRS BSSGP protocol implementation as per 3GPP TS 08.18 */
-
-/* (C) 2009-2017 by Harald Welte <laforge@gnumonks.org>
+/*! \file gprs_bssgp.c
+ * GPRS BSSGP protocol implementation as per 3GPP TS 08.18. */
+/*
+ * (C) 2009-2017 by Harald Welte <laforge@gnumonks.org>
  *
  * All Rights Reserved
  *
diff --git a/src/gb/gprs_bssgp_bss.c b/src/gb/gprs_bssgp_bss.c
index f41c4a4f..d9f04c5f 100644
--- a/src/gb/gprs_bssgp_bss.c
+++ b/src/gb/gprs_bssgp_bss.c
@@ -1,6 +1,7 @@
-/* GPRS BSSGP protocol implementation as per 3GPP TS 08.18 */
-
-/* (C) 2009-2017 by Harald Welte <laforge@gnumonks.org>
+/*! \file gprs_bssgp_bss.c
+ * GPRS BSSGP protocol implementation as per 3GPP TS 08.18. */
+/*
+ * (C) 2009-2017 by Harald Welte <laforge@gnumonks.org>
  *
  * All Rights Reserved
  *
diff --git a/src/gb/gprs_bssgp_util.c b/src/gb/gprs_bssgp_util.c
index 88916c17..78a11a36 100644
--- a/src/gb/gprs_bssgp_util.c
+++ b/src/gb/gprs_bssgp_util.c
@@ -1,6 +1,7 @@
-/* GPRS BSSGP protocol implementation as per 3GPP TS 08.18 */
-
-/* (C) 2009-2017 by Harald Welte <laforge@gnumonks.org>
+/*! \file gprs_bssgp_util.c
+ * GPRS BSSGP protocol implementation as per 3GPP TS 08.18. */
+/*
+ * (C) 2009-2017 by Harald Welte <laforge@gnumonks.org>
  *
  * All Rights Reserved
  *
diff --git a/src/gb/gprs_bssgp_vty.c b/src/gb/gprs_bssgp_vty.c
index f3f354cc..703d130a 100644
--- a/src/gb/gprs_bssgp_vty.c
+++ b/src/gb/gprs_bssgp_vty.c
@@ -1,6 +1,7 @@
-/* VTY interface for our GPRS BSS Gateway Protocol (BSSGP) implementation */
-
-/* (C) 2010 by Harald Welte <laforge@gnumonks.org>
+/*! \file gprs_bssgp_vty.c
+ * VTY interface for our GPRS BSS Gateway Protocol (BSSGP) implementation. */
+/*
+ * (C) 2010 by Harald Welte <laforge@gnumonks.org>
  *
  * All Rights Reserved
  *
diff --git a/src/gb/gprs_ns.c b/src/gb/gprs_ns.c
index 51d1c3c0..d20ed232 100644
--- a/src/gb/gprs_ns.c
+++ b/src/gb/gprs_ns.c
@@ -1,7 +1,8 @@
-/* GPRS Networks Service (NS) messages on the Gb interface
- * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05) */
-
-/* (C) 2009-2012 by Harald Welte <laforge@gnumonks.org>
+/*! \file gprs_ns.c
+ * GPRS Networks Service (NS) messages on the Gb interface.
+ * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05). */
+/*
+ * (C) 2009-2012 by Harald Welte <laforge@gnumonks.org>
  *
  * All Rights Reserved
  *
@@ -22,11 +23,7 @@
 
 /*! \addtogroup libgb
  *  @{
- */
-
-/*! \file gprs_ns.c */
-
-/*!
+ *
  * GPRS Networks Service (NS) messages on the Gb interface
  * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05) 
  *
@@ -36,30 +33,31 @@
  * do much, apart from providing congestion notification and status indication.
  *
  * Terms:
+ *
  * 	NS		Network Service
- *	NSVC		NS Virtual Connection
- *	NSEI		NS Entity Identifier
- *	NSVL		NS Virtual Link
- *	NSVLI		NS Virtual Link Identifier
- *	BVC		BSSGP Virtual Connection
- *	BVCI		BSSGP Virtual Connection Identifier
- *	NSVCG		NS Virtual Connection Goup
- *	Blocked		NS-VC cannot be used for user traffic
- *	Alive		Ability of a NS-VC to provide communication
+ * 	NSVC		NS Virtual Connection
+ * 	NSEI		NS Entity Identifier
+ * 	NSVL		NS Virtual Link
+ * 	NSVLI		NS Virtual Link Identifier
+ * 	BVC		BSSGP Virtual Connection
+ * 	BVCI		BSSGP Virtual Connection Identifier
+ * 	NSVCG		NS Virtual Connection Goup
+ * 	Blocked		NS-VC cannot be used for user traffic
+ * 	Alive		Ability of a NS-VC to provide communication
  *
- *  There can be multiple BSSGP virtual connections over one (group of) NSVC's.  BSSGP will
+ * There can be multiple BSSGP virtual connections over one (group of) NSVC's.  BSSGP will
  * therefore identify the BSSGP virtual connection by a BVCI passed down to NS.
  * NS then has to firgure out which NSVC's are responsible for this BVCI.
  * Those mappings are administratively configured.
- */
-
-/* This implementation has the following limitations:
- *  o Only one NS-VC for each NSE: No load-sharing function
- *  o NSVCI 65535 and 65534 are reserved for internal use
- *  o Only UDP is supported as of now, no frame relay support
- *  o The IP Sub-Network-Service (SNS) as specified in 48.016 is not implemented
- *  o There are no BLOCK and UNBLOCK timers (yet?)
- */
+ *
+ * This implementation has the following limitations:
+ * - Only one NS-VC for each NSE: No load-sharing function
+ * - NSVCI 65535 and 65534 are reserved for internal use
+ * - Only UDP is supported as of now, no frame relay support
+ * - The IP Sub-Network-Service (SNS) as specified in 48.016 is not implemented
+ * - There are no BLOCK and UNBLOCK timers (yet?)
+ *
+ * \file gprs_ns.c */
 
 #include <stdlib.h>
 #include <unistd.h>
diff --git a/src/gb/gprs_ns_frgre.c b/src/gb/gprs_ns_frgre.c
index 285a9a07..52145ff6 100644
--- a/src/gb/gprs_ns_frgre.c
+++ b/src/gb/gprs_ns_frgre.c
@@ -1,9 +1,9 @@
-/* GPRS Networks Service (NS) messages on the Gb interface
- * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05) */
-
-/* NS-over-FR-over-GRE implementation */
-
-/* (C) 2009-2010 by Harald Welte <laforge@gnumonks.org>
+/*! \file gprs_ns_frgre.c
+ * NS-over-FR-over-GRE implementation.
+ * GPRS Networks Service (NS) messages on the Gb interface,
+ * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05). */
+/*
+ * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org>
  *
  * All Rights Reserved
  *
diff --git a/src/gb/gprs_ns_vty.c b/src/gb/gprs_ns_vty.c
index bdccb3ff..e320ba29 100644
--- a/src/gb/gprs_ns_vty.c
+++ b/src/gb/gprs_ns_vty.c
@@ -1,6 +1,7 @@
-/* VTY interface for our GPRS Networks Service (NS) implementation */
-
-/* (C) 2009-2010 by Harald Welte <laforge@gnumonks.org>
+/*! \file gprs_ns_vty.c
+ * VTY interface for our GPRS Networks Service (NS) implementation. */
+/*
+ * (C) 2009-2010 by Harald Welte <laforge@gnumonks.org>
  *
  * All Rights Reserved
  *