| commit | 17518fe393a37781c84d09836256bb1a6256032b | [log] [tgz] |
|---|---|---|
| author | Neels Hofmeyr <nhofmeyr@sysmocom.de> | Tue Jun 20 04:35:06 2017 +0200 |
| committer | Neels Hofmeyr <nhofmeyr@sysmocom.de> | Fri Jun 23 00:18:23 2017 +0000 |
| tree | 6a39eb3b0b86fa7407ea04a00410aaa1b588d3d3 | |
| parent | 33370cb18d3dda2bccbf2648f40d9614693ed0ea [diff] [blame] |
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
diff --git a/include/osmocom/core/msgfile.h b/include/osmocom/core/msgfile.h index cab97b2..800b431 100644 --- a/include/osmocom/core/msgfile.h +++ b/include/osmocom/core/msgfile.h
@@ -1,3 +1,4 @@ +/*! \file msgfile.h */ /* * (C) 2010 by Holger Hans Peter Freyther * (C) 2010 by On-Waves