summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorNeels Hofmeyr <nhofmeyr@sysmocom.de>2017-06-20 04:35:06 +0200
committerNeels Hofmeyr <nhofmeyr@sysmocom.de>2017-06-23 00:18:23 +0000
commit17518fe393a37781c84d09836256bb1a6256032b (patch)
tree6a39eb3b0b86fa7407ea04a00410aaa1b588d3d3 /src
parent33370cb18d3dda2bccbf2648f40d9614693ed0ea (diff)
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
Diffstat (limited to 'src')
-rw-r--r--src/application.c7
-rw-r--r--src/backtrace.c6
-rw-r--r--src/bitcomp.c13
-rw-r--r--src/bits.c8
-rw-r--r--src/bitvec.c17
-rw-r--r--src/codec/gsm610.c4
-rw-r--r--src/codec/gsm620.c4
-rw-r--r--src/codec/gsm660.c4
-rw-r--r--src/codec/gsm690.c4
-rw-r--r--src/coding/gsm0503_coding.c5
-rw-r--r--src/coding/gsm0503_interleaving.c63
-rw-r--r--src/coding/gsm0503_mapping.c5
-rw-r--r--src/coding/gsm0503_parity.c5
-rw-r--r--src/coding/gsm0503_tables.c7
-rw-r--r--src/conv.c12
-rw-r--r--src/conv_acc.c4
-rw-r--r--src/conv_acc_generic.c6
-rw-r--r--src/conv_acc_sse.c6
-rw-r--r--src/conv_acc_sse_avx.c6
-rw-r--r--src/conv_acc_sse_impl.h8
-rw-r--r--src/crc16.c2
-rw-r--r--src/crcXXgen.c.tpl15
-rw-r--r--src/ctrl/control_cmd.c5
-rw-r--r--src/ctrl/control_if.c5
-rw-r--r--src/ctrl/control_vty.c5
-rw-r--r--src/ctrl/fsm_ctrl_commands.c2
-rw-r--r--src/fsm.c10
-rw-r--r--src/gb/common_vty.c6
-rw-r--r--src/gb/common_vty.h2
-rw-r--r--src/gb/gprs_bssgp.c7
-rw-r--r--src/gb/gprs_bssgp_bss.c7
-rw-r--r--src/gb/gprs_bssgp_util.c7
-rw-r--r--src/gb/gprs_bssgp_vty.c7
-rw-r--r--src/gb/gprs_ns.c54
-rw-r--r--src/gb/gprs_ns_frgre.c12
-rw-r--r--src/gb/gprs_ns_vty.c7
-rw-r--r--src/gsm/a5.c14
-rw-r--r--src/gsm/abis_nm.c13
-rw-r--r--src/gsm/apn.c2
-rw-r--r--src/gsm/auth_comp128v1.c8
-rw-r--r--src/gsm/auth_comp128v23.c11
-rw-r--r--src/gsm/auth_core.c7
-rw-r--r--src/gsm/auth_milenage.c7
-rw-r--r--src/gsm/comp128.c75
-rw-r--r--src/gsm/comp128v23.c14
-rw-r--r--src/gsm/gan.c10
-rw-r--r--src/gsm/gea.c11
-rw-r--r--src/gsm/gprs_cipher_core.c7
-rw-r--r--src/gsm/gprs_gea.c6
-rw-r--r--src/gsm/gprs_rlc.c8
-rw-r--r--src/gsm/gsm0341.c1
-rw-r--r--src/gsm/gsm0411_smc.c9
-rw-r--r--src/gsm/gsm0411_smr.c7
-rw-r--r--src/gsm/gsm0411_utils.c9
-rw-r--r--src/gsm/gsm0414.c2
-rw-r--r--src/gsm/gsm0480.c4
-rw-r--r--src/gsm/gsm0502.c7
-rw-r--r--src/gsm/gsm0808.c4
-rw-r--r--src/gsm/gsm0808_utils.c4
-rw-r--r--src/gsm/gsm48.c7
-rw-r--r--src/gsm/gsm48_ie.c9
-rw-r--r--src/gsm/gsm_04_08_gprs.c4
-rw-r--r--src/gsm/gsm_utils.c1
-rw-r--r--src/gsm/gsup.c4
-rw-r--r--src/gsm/ipa.c7
-rw-r--r--src/gsm/kasumi.c7
-rw-r--r--src/gsm/lapd_core.c17
-rw-r--r--src/gsm/lapdm.c12
-rw-r--r--src/gsm/milenage/aes-encblock.c4
-rw-r--r--src/gsm/milenage/aes-internal-enc.c7
-rw-r--r--src/gsm/milenage/aes-internal.c7
-rw-r--r--src/gsm/milenage/aes.h3
-rw-r--r--src/gsm/milenage/aes_i.h3
-rw-r--r--src/gsm/milenage/aes_wrap.h7
-rw-r--r--src/gsm/milenage/common.h1
-rw-r--r--src/gsm/milenage/milenage.c3
-rw-r--r--src/gsm/milenage/milenage.h4
-rw-r--r--src/gsm/oap.c7
-rw-r--r--src/gsm/rsl.c14
-rw-r--r--src/gsm/rxlev_stat.c7
-rw-r--r--src/gsm/sysinfo.c7
-rw-r--r--src/gsm/tlv_parser.c5
-rw-r--r--src/gsmtap_util.c9
-rw-r--r--src/logging.c12
-rw-r--r--src/logging_gsmtap.c22
-rw-r--r--src/logging_syslog.c13
-rw-r--r--src/loggingrb.c13
-rw-r--r--src/macaddr.c8
-rw-r--r--src/msgb.c5
-rw-r--r--src/msgfile.c4
-rw-r--r--src/panic.c9
-rw-r--r--src/plugin.c14
-rw-r--r--src/prim.c2
-rw-r--r--src/pseudotalloc/pseudotalloc.c6
-rw-r--r--src/pseudotalloc/talloc.h9
-rw-r--r--src/rate_ctr.c10
-rw-r--r--src/select.c13
-rw-r--r--src/sercomm.c10
-rw-r--r--src/serial.c11
-rw-r--r--src/signal.c13
-rw-r--r--src/sim/card_fs_isim.c3
-rw-r--r--src/sim/card_fs_sim.c3
-rw-r--r--src/sim/card_fs_tetra.c3
-rw-r--r--src/sim/card_fs_uicc.c3
-rw-r--r--src/sim/card_fs_usim.c3
-rw-r--r--src/sim/class_tables.c5
-rw-r--r--src/sim/core.c3
-rw-r--r--src/sim/gsm_int.h2
-rw-r--r--src/sim/reader.c3
-rw-r--r--src/sim/reader_pcsc.c3
-rw-r--r--src/sim/sim_int.h2
-rw-r--r--src/socket.c7
-rw-r--r--src/stat_item.c12
-rw-r--r--src/statistics.c7
-rw-r--r--src/stats.c1
-rw-r--r--src/stats_statsd.c1
-rw-r--r--src/strrb.c36
-rw-r--r--src/timer.c5
-rw-r--r--src/timer_gettimeofday.c5
-rw-r--r--src/utils.c5
-rw-r--r--src/vty/buffer.c3
-rw-r--r--src/vty/command.c4
-rw-r--r--src/vty/fsm_vty.c6
-rw-r--r--src/vty/logging_vty.c6
-rw-r--r--src/vty/stats_vty.c6
-rw-r--r--src/vty/telnet_interface.c7
-rw-r--r--src/vty/utils.c9
-rw-r--r--src/vty/vector.c4
-rw-r--r--src/vty/vty.c3
-rw-r--r--src/write_queue.c8
130 files changed, 532 insertions, 553 deletions
diff --git a/src/application.c b/src/application.c
index e7c8e0f9..aec3fd7b 100644
--- a/src/application.c
+++ b/src/application.c
@@ -1,4 +1,5 @@
-/* Utility functions to setup applications */
+/*! \file application.c
+ * Routines for helping with the osmocom application setup. */
/*
* (C) 2010 by Harald Welte <laforge@gnumonks.org>
* (C) 2011 by Holger Hans Peter Freyther
@@ -21,10 +22,6 @@
*
*/
-/*! \file application.c
- * Routines for helping with the osmocom application setup.
- */
-
/*! \mainpage libosmocore Documentation
* \section sec_intro Introduction
* This library is a collection of common code used in various
diff --git a/src/backtrace.c b/src/backtrace.c
index 0240a758..5ce74825 100644
--- a/src/backtrace.c
+++ b/src/backtrace.c
@@ -1,3 +1,5 @@
+/*! \file backtrace.c
+ * Routines related to generating call back traces. */
/*
* (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org>
* (C) 2012 by Harald Welte <laforge@gnumonks.org>
@@ -20,10 +22,6 @@
*
*/
-/*! \file backtrace.c
- * Routines realted to generating call back traces
- */
-
#include <stdio.h>
#include <stdlib.h>
#include <osmocom/core/utils.h>
diff --git a/src/bitcomp.c b/src/bitcomp.c
index acf165e0..94f60eb3 100644
--- a/src/bitcomp.c
+++ b/src/bitcomp.c
@@ -1,6 +1,7 @@
-/* bit compression routines */
-
-/* (C) 2016 sysmocom s.f.m.c. GmbH by Max Suraev <msuraev@sysmocom.de>
+/*! \file bitcomp.c
+ * Osmocom bit compression routines */
+/*
+ * (C) 2016 sysmocom s.f.m.c. GmbH by Max Suraev <msuraev@sysmocom.de>
*
* All Rights Reserved
*
@@ -22,11 +23,7 @@
/*! \defgroup bitcomp Bit compression
* @{
- */
-
-/*! \file bitcomp.c
- * Osmocom bit compression routines
- */
+ * \file bitcomp.c */
#include <stdint.h>
#include <stdbool.h>
diff --git a/src/bits.c b/src/bits.c
index 45ac8e24..af09441a 100644
--- a/src/bits.c
+++ b/src/bits.c
@@ -26,11 +26,9 @@
/*! \addtogroup bits
* @{
- * Osmocom bit level support code
- */
-
-/*! \file bits.c */
-
+ * Osmocom bit level support code.
+ *
+ * \file bits.c */
/*! convert unpacked bits to packed bits, return length in bytes
* \param[out] out output buffer of packed bits