diff options
| author | Neels Hofmeyr <nhofmeyr@sysmocom.de> | 2017-06-20 04:35:06 +0200 |
|---|---|---|
| committer | Neels Hofmeyr <nhofmeyr@sysmocom.de> | 2017-06-23 00:18:23 +0000 |
| commit | 17518fe393a37781c84d09836256bb1a6256032b (patch) | |
| tree | 6a39eb3b0b86fa7407ea04a00410aaa1b588d3d3 /src/gsm/a5.c | |
| parent | 33370cb18d3dda2bccbf2648f40d9614693ed0ea (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/gsm/a5.c')
| -rw-r--r-- | src/gsm/a5.c | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/src/gsm/a5.c b/src/gsm/a5.c index f21554f0..e906b6d9 100644 --- a/src/gsm/a5.c +++ b/src/gsm/a5.c @@ -1,12 +1,11 @@ -/* - * a5.c - * - * Full reimplementation of A5/1,2 (split and threadsafe) +/*! \file a5.c + * Full reimplementation of A5/1,2 (split and threadsafe). * * The logic behind the algorithm is taken from "A pedagogical implementation * of the GSM A5/1 and A5/2 "voice privacy" encryption algorithms." by * Marc Briceno, Ian Goldberg, and David Wagner. - * + */ +/* * Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com> * * All Rights Reserved @@ -29,9 +28,8 @@ /*! \addtogroup crypto * @{ * Osmocom GSM/GPRS ciphering algorithm implementation - */ - -/*! \file gsm/a5.c */ + * + * \file gsm/a5.c */ #include <errno.h> #include <string.h> |