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/bitvec.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/bitvec.c')
| -rw-r--r-- | src/bitvec.c | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/src/bitvec.c b/src/bitvec.c index 8ed7296a..f07b42c3 100644 --- a/src/bitvec.c +++ b/src/bitvec.c @@ -1,5 +1,3 @@ -/* bit vector utility routines */ - /* (C) 2009 by Harald Welte <laforge@gnumonks.org> * (C) 2012 Ivan Klyuchnikov * (C) 2015 by Sysmocom s.f.m.c. GmbH @@ -24,10 +22,17 @@ /*! \addtogroup bitvec * @{ - * Osmocom bit vector abstraction - */ - -/*! \file bitvec.c */ + * Osmocom bit vector abstraction utility routines. + * + * These functions assume a MSB (most significant bit) first layout of the + * bits, so that for instance the 5 bit number abcde (a is MSB) can be + * embedded into a byte sequence like in xxxxxxab cdexxxxx. The bit count + * starts with the MSB, so the bits in a byte are numbered (MSB) 01234567 (LSB). + * Note that there are other incompatible encodings, like it is used + * for the EGPRS RLC data block headers (there the bits are numbered from LSB + * to MSB). + * + * \file bitvec.c */ #include <errno.h> #include <stdint.h> |