aboutsummaryrefslogtreecommitdiffstats
path: root/src/crcXXgen.c.tpl
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/crcXXgen.c.tpl
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/crcXXgen.c.tpl')
-rw-r--r--src/crcXXgen.c.tpl15
1 files changed, 5 insertions, 10 deletions
diff --git a/src/crcXXgen.c.tpl b/src/crcXXgen.c.tpl
index 9c63052d..e92a5381 100644
--- a/src/crcXXgen.c.tpl
+++ b/src/crcXXgen.c.tpl
@@ -1,8 +1,6 @@
+/*! \file crcXXgen.c
+ * Osmocom generic CRC routines (for max XX bits poly). */
/*
- * crcXXgen.c
- *
- * Generic CRC routines (for max XX bits poly)
- *
* Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com>
*
* All Rights Reserved
@@ -24,12 +22,9 @@
/*! \addtogroup crcgen
* @{
- * Osmocom generic CRC routines
- */
-
-/*! \file crcXXgen.c
- * Osmocom generic CRC routines (for max XX bits poly)
- */
+ * Osmocom generic CRC routines (for max XX bits poly).
+ *
+ * \file crcXXgen.c.tpl */
#include <stdint.h>