aboutsummaryrefslogtreecommitdiffstats
path: root/include/osmocom/sim
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 /include/osmocom/sim
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 'include/osmocom/sim')
-rw-r--r--include/osmocom/sim/class_tables.h9
-rw-r--r--include/osmocom/sim/sim.h9
2 files changed, 9 insertions, 9 deletions
diff --git a/include/osmocom/sim/class_tables.h b/include/osmocom/sim/class_tables.h
index ad89d949..d5be39dd 100644
--- a/include/osmocom/sim/class_tables.h
+++ b/include/osmocom/sim/class_tables.h
@@ -1,7 +1,6 @@
-#pragma once
-
-/* simtrace - tables determining APDU case for card emulation
- *
+/*! \file class_tables.h
+ * simtrace - tables determining APDU case for card emulation. */
+/*
* (C) 2016 by Harald Welte <laforge@gnumonks.org>
*
* This program is free software; you can redistribute it and/or modify
@@ -18,6 +17,8 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+#pragma once
+
#include <stdint.h>
struct osim_cla_ins_case {
diff --git a/include/osmocom/sim/sim.h b/include/osmocom/sim/sim.h
index eb954807..680cad15 100644
--- a/include/osmocom/sim/sim.h
+++ b/include/osmocom/sim/sim.h
@@ -1,3 +1,7 @@
+/*! \file sim.h
+ * Routines for helping with SIM (ISO/IEC 7816-4 more generally) communication.
+ */
+
#ifndef _OSMOCOM_SIM_H
#define _OSMOCOM_SIM_H
@@ -6,11 +10,6 @@
#define APDU_HDR_LEN 5
-/*!
- * \file sim.h
- * Routines for helping with SIM (ISO/IEC 7816-4 more generally) communication.
- */
-
/*! command-response pairs cases
*
* Enumeration used to identify the APDU structure based on command-response pair case , as specified in ISO/IEC 7816-3:2006(E) ยง12.1.