aboutsummaryrefslogtreecommitdiffstats
path: root/include/osmocom/ctrl
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/ctrl
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/ctrl')
-rw-r--r--include/osmocom/ctrl/control_cmd.h2
-rw-r--r--include/osmocom/ctrl/control_if.h2
-rw-r--r--include/osmocom/ctrl/control_vty.h2
-rw-r--r--include/osmocom/ctrl/ports.h6
4 files changed, 9 insertions, 3 deletions
diff --git a/include/osmocom/ctrl/control_cmd.h b/include/osmocom/ctrl/control_cmd.h
index 3cef9d80..77532e66 100644
--- a/include/osmocom/ctrl/control_cmd.h
+++ b/include/osmocom/ctrl/control_cmd.h
@@ -1,3 +1,5 @@
+/*! \file control_cmd.h */
+
#pragma once
#include <osmocom/core/msgb.h>
diff --git a/include/osmocom/ctrl/control_if.h b/include/osmocom/ctrl/control_if.h
index 4cd33699..6e49742d 100644
--- a/include/osmocom/ctrl/control_if.h
+++ b/include/osmocom/ctrl/control_if.h
@@ -1,3 +1,5 @@
+/*! \file control_if.h */
+
#pragma once
#include <osmocom/core/write_queue.h>
diff --git a/include/osmocom/ctrl/control_vty.h b/include/osmocom/ctrl/control_vty.h
index d0ef69f4..af9ee991 100644
--- a/include/osmocom/ctrl/control_vty.h
+++ b/include/osmocom/ctrl/control_vty.h
@@ -1,3 +1,5 @@
+/*! \file control_vty.h */
+
#pragma once
/* Add the 'ctrl' section to VTY, containing the 'bind' command. */
diff --git a/include/osmocom/ctrl/ports.h b/include/osmocom/ctrl/ports.h
index d28066e6..f974daf4 100644
--- a/include/osmocom/ctrl/ports.h
+++ b/include/osmocom/ctrl/ports.h
@@ -1,6 +1,4 @@
-#pragma once
-
-/*
+/*! \file ports.h
* TCP port numbers used for CTRL interfaces in osmocom projects. See also the
* osmocom wiki as well as the osmo-gsm-manuals, which should all be kept in
* sync with this file:
@@ -8,6 +6,8 @@
* https://git.osmocom.org/osmo-gsm-manuals/tree/common/chapters/port_numbers.adoc
*/
+#pragma once
+
#define OSMO_CTRL_PORT_BTS 4238
#define OSMO_CTRL_PORT_NITB_BSC 4249
#define OSMO_CTRL_PORT_BSC_NAT 4250