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/vty/buffer.h b/include/osmocom/vty/buffer.h
index 56c28f0..b5cce8a 100644
--- a/include/osmocom/vty/buffer.h
+++ b/include/osmocom/vty/buffer.h
@@ -1,5 +1,6 @@
+/*! \file buffer.h
+ * Buffering to output and input. */
/*
- * Buffering to output and input.
* Copyright (C) 1998 Kunihiro Ishiguro
*
* This file is part of GNU Zebra.
diff --git a/include/osmocom/vty/command.h b/include/osmocom/vty/command.h
index 9a072d7..0fa5175 100644
--- a/include/osmocom/vty/command.h
+++ b/include/osmocom/vty/command.h
@@ -1,5 +1,6 @@
+/*! \file command.h
+ * Zebra configuration command interface routine. */
/*
- * Zebra configuration command interface routine
* Copyright (C) 1997, 98 Kunihiro Ishiguro
*
* This file is part of GNU Zebra.
@@ -28,8 +29,7 @@
/*! \defgroup command VTY Command
* @{
- */
-/*! \file command.h */
+ * \file command.h */
/*! Host configuration variable */
struct host {
diff --git a/include/osmocom/vty/logging.h b/include/osmocom/vty/logging.h
index 544d117..9bafb98 100644
--- a/include/osmocom/vty/logging.h
+++ b/include/osmocom/vty/logging.h
@@ -1,3 +1,5 @@
+/*! \file logging.h */
+
#pragma once
#define LOGGING_STR "Configure log message to this terminal\n"
diff --git a/include/osmocom/vty/misc.h b/include/osmocom/vty/misc.h
index b3fb644..545955c 100644
--- a/include/osmocom/vty/misc.h
+++ b/include/osmocom/vty/misc.h
@@ -1,3 +1,5 @@
+/*! \file misc.h */
+
#pragma once
#include <osmocom/vty/vty.h>
diff --git a/include/osmocom/vty/ports.h b/include/osmocom/vty/ports.h
index a6043b3..8f8ef75 100644
--- a/include/osmocom/vty/ports.h
+++ b/include/osmocom/vty/ports.h
@@ -1,6 +1,4 @@
-#pragma once
-
-/*
+/*! \file ports.h
* TCP port numbers used for VTY 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
+
/* 4238 used by osmo-bts control interface */
#define OSMO_VTY_PORT_STP 4239
#define OSMO_VTY_PORT_PCU 4240 /* also: osmo_pcap_client */
diff --git a/include/osmocom/vty/stats.h b/include/osmocom/vty/stats.h
index 3851b4d..7629928 100644
--- a/include/osmocom/vty/stats.h
+++ b/include/osmocom/vty/stats.h
@@ -1,3 +1,5 @@
+/*! \file stats.h */
+
#pragma once
void osmo_stats_vty_add_cmds();
diff --git a/include/osmocom/vty/telnet_interface.h b/include/osmocom/vty/telnet_interface.h
index bca9156..d653466 100644
--- a/include/osmocom/vty/telnet_interface.h
+++ b/include/osmocom/vty/telnet_interface.h
@@ -1,5 +1,7 @@
-/* minimalistic telnet/network interface it might turn into a wire interface */
-/* (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org>
+/*! \file telnet_interface.h
+ * minimalistic telnet/network interface it might turn into a wire interface */
+/*
+ * (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org>
* All Rights Reserved
*
* This program is free software; you can redistribute it and/or modify
@@ -27,9 +29,7 @@
/*! \defgroup telnet_interface Telnet Interface
* @{
- */
-
-/*! \file telnet_interface.h */
+ * \file telnet_interface.h */
/*! A telnet connection */
struct telnet_connection {
diff --git a/include/osmocom/vty/vector.h b/include/osmocom/vty/vector.h
index c00804d..0a639ad 100644
--- a/include/osmocom/vty/vector.h
+++ b/include/osmocom/vty/vector.h
@@ -1,5 +1,6 @@
+/*! \file vector.h
+ * Generic vector interface header. */
/*
- * Generic vector interface header.
* Copyright (C) 1997, 98 Kunihiro Ishiguro
*
* This file is part of GNU Zebra.
diff --git a/include/osmocom/vty/vty.h b/include/osmocom/vty/vty.h
index d59f5d4..544e1fa 100644
--- a/include/osmocom/vty/vty.h
+++ b/include/osmocom/vty/vty.h
@@ -5,8 +5,7 @@
/*! \defgroup vty VTY (Virtual TTY) interface
* @{
- */
-/*! \file vty.h */
+ * \file vty.h */
/* GCC have printf type attribute check. */
#ifdef __GNUC__