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
diff --git a/src/sim/card_fs_isim.c b/src/sim/card_fs_isim.c
index 339e862..1073429 100644
--- a/src/sim/card_fs_isim.c
+++ b/src/sim/card_fs_isim.c
@@ -1,4 +1,5 @@
-/* 3GPP ISIM specific structures / routines */
+/*! \file card_fs_isim.c
+ * 3GPP ISIM specific structures / routines. */
/*
* (C) 2014 by Harald Welte <laforge@gnumonks.org>
*
diff --git a/src/sim/card_fs_sim.c b/src/sim/card_fs_sim.c
index 432c945..1411129 100644
--- a/src/sim/card_fs_sim.c
+++ b/src/sim/card_fs_sim.c
@@ -1,4 +1,5 @@
-/* classic SIM card specific structures/routines */
+/*! \file card_fs_sim.c
+ * classic SIM card specific structures/routines. */
/*
* (C) 2012-2014 by Harald Welte <laforge@gnumonks.org>
*
diff --git a/src/sim/card_fs_tetra.c b/src/sim/card_fs_tetra.c
index 657e55f..80f3284 100644
--- a/src/sim/card_fs_tetra.c
+++ b/src/sim/card_fs_tetra.c
@@ -1,4 +1,5 @@
-/* TETRA SIM card specific structures/routines */
+/*! \file card_fs_tetra.c
+ * TETRA SIM card specific structures/routines. */
/*
* (C) 2014 by Harald Welte <laforge@gnumonks.org>
*
diff --git a/src/sim/card_fs_uicc.c b/src/sim/card_fs_uicc.c
index 27afe34..8ff8936 100644
--- a/src/sim/card_fs_uicc.c
+++ b/src/sim/card_fs_uicc.c
@@ -1,4 +1,5 @@
-/* ETSI UICC specific structures / routines */
+/*! \file card_fs_uicc.c
+ * ETSI UICC specific structures / routines. */
/*
* (C) 2012 by Harald Welte <laforge@gnumonks.org>
*
diff --git a/src/sim/card_fs_usim.c b/src/sim/card_fs_usim.c
index 22c193f..9e9fc87 100644
--- a/src/sim/card_fs_usim.c
+++ b/src/sim/card_fs_usim.c
@@ -1,4 +1,5 @@
-/* 3GPP USIM specific structures / routines */
+/*! \file card_fs_usim.c
+ * 3GPP USIM specific structures / routines. */
/*
* (C) 2012-2014 by Harald Welte <laforge@gnumonks.org>
*
diff --git a/src/sim/class_tables.c b/src/sim/class_tables.c
index c3e18d8..fcf67f0 100644
--- a/src/sim/class_tables.c
+++ b/src/sim/class_tables.c
@@ -1,5 +1,6 @@
-/* simtrace - tables determining APDU case for card emulation
- *
+/*! \file class_tables.c
+ * simtrace - tables determining APDU case for card emulation. */
+/*
* (C) 2016 by Harald Welte <laforge@gnumonks.org>
*
* This program is free software; you can redistribute it and/or modify
diff --git a/src/sim/core.c b/src/sim/core.c
index 15a1563..8da839c 100644
--- a/src/sim/core.c
+++ b/src/sim/core.c
@@ -1,4 +1,5 @@
-/* Core routines for SIM/UICC/USIM access */
+/*! \file core.c
+ * Core routines for SIM/UICC/USIM access. */
/*
* (C) 2012 by Harald Welte <laforge@gnumonks.org>
*
diff --git a/src/sim/gsm_int.h b/src/sim/gsm_int.h
index 54a2fbf..42ccca7 100644
--- a/src/sim/gsm_int.h
+++ b/src/sim/gsm_int.h
@@ -1,3 +1,5 @@
+/*! \file gsm_int.h */
+
#include <sys/types.h>
#include <osmocom/sim/sim.h>
diff --git a/src/sim/reader.c b/src/sim/reader.c
index e7169b5..f39829b 100644
--- a/src/sim/reader.c
+++ b/src/sim/reader.c
@@ -1,4 +1,5 @@
-/* Card reader abstraction for libosmosim */
+/*! \file reader.c
+ * Card reader abstraction for libosmosim. */
/*
* (C) 2012 by Harald Welte <laforge@gnumonks.org>
*
diff --git a/src/sim/reader_pcsc.c b/src/sim/reader_pcsc.c
index f020142..5b29638 100644
--- a/src/sim/reader_pcsc.c
+++ b/src/sim/reader_pcsc.c
@@ -1,4 +1,5 @@
-/* PC/SC Card reader backend for libosmosim */
+/*! \file reader_pcsc.c
+ * PC/SC Card reader backend for libosmosim. */
/*
* (C) 2012 by Harald Welte <laforge@gnumonks.org>
*
diff --git a/src/sim/sim_int.h b/src/sim/sim_int.h
index 7b07b83..885011e 100644
--- a/src/sim/sim_int.h
+++ b/src/sim/sim_int.h
@@ -1,3 +1,5 @@
+/*! \file sim_int.h */
+
#ifndef _SIM_INT_H
#include <osmocom/sim/sim.h>