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/crypt | |
| 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/crypt')
| -rw-r--r-- | include/osmocom/crypt/auth.h | 4 | ||||
| -rw-r--r-- | include/osmocom/crypt/gprs_cipher.h | 2 |
2 files changed, 3 insertions, 3 deletions
diff --git a/include/osmocom/crypt/auth.h b/include/osmocom/crypt/auth.h index af4ae153..2f88a3a4 100644 --- a/include/osmocom/crypt/auth.h +++ b/include/osmocom/crypt/auth.h @@ -2,9 +2,7 @@ /*! \addtogroup auth * @{ - */ - -/*! \file auth.h */ + * \file auth.h */ #include <stdint.h> diff --git a/include/osmocom/crypt/gprs_cipher.h b/include/osmocom/crypt/gprs_cipher.h index c302f10b..20f0514b 100644 --- a/include/osmocom/crypt/gprs_cipher.h +++ b/include/osmocom/crypt/gprs_cipher.h @@ -1,3 +1,5 @@ +/*! \file gprs_cipher.h */ + #pragma once #include <osmocom/core/linuxlist.h> |