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 /include/osmocom/gsm/a5.h | |
| 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 'include/osmocom/gsm/a5.h')
| -rw-r--r-- | include/osmocom/gsm/a5.h | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/include/osmocom/gsm/a5.h b/include/osmocom/gsm/a5.h index 893fb026..fae3fdd4 100644 --- a/include/osmocom/gsm/a5.h +++ b/include/osmocom/gsm/a5.h @@ -1,6 +1,6 @@ +/*! \file gsm/a5.h + * Osmocom GSM A5 ciphering algorithm header. */ /* - * a5.h - * * Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com> * * All Rights Reserved @@ -29,11 +29,7 @@ /*! \defgroup a5 GSM A5 ciphering algorithm * @{ - */ - -/*! \file gsm/a5.h - * Osmocom GSM A5 ciphering algorithm header - */ + * \file a5.h */ /*! Converts a frame number into the 22 bit number used in A5/x * \param[in] fn The true framenumber |