From c28c6a02d224ed74878fe4899870d693de15f54d Mon Sep 17 00:00:00 2001
From: Katerina Barone-Adesi <kat.obsc@gmail.com>
Date: Fri, 15 Feb 2013 13:27:59 +0100
Subject: misc: Doxygen tweaks: fixed some typos and minor errors

Doxygen generates quite a lot of warnings on libosmocore. Some of them
are obvious typos - this patch aims to fix such low-hanging fruit.
---
 include/osmocom/core/conv.h         | 2 +-
 include/osmocom/core/crcXXgen.h.tpl | 2 +-
 include/osmocom/core/crcgen.h       | 2 +-
 include/osmocom/core/gsmtap_util.h  | 2 ++
 include/osmocom/core/logging.h      | 2 +-
 include/osmocom/core/msgb.h         | 2 +-
 include/osmocom/core/prim.h         | 6 ++++--
 include/osmocom/core/serial.h       | 2 +-
 include/osmocom/core/statistics.h   | 2 +-
 9 files changed, 13 insertions(+), 9 deletions(-)

(limited to 'include/osmocom/core')

diff --git a/include/osmocom/core/conv.h b/include/osmocom/core/conv.h
index e5b2a975..4cc791fa 100644
--- a/include/osmocom/core/conv.h
+++ b/include/osmocom/core/conv.h
@@ -25,7 +25,7 @@
  */
 
 /*! \file conv.h
- *  \file Osmocom convolutional encoder and decoder
+ * Osmocom convolutional encoder and decoder
  */
 
 #ifndef __OSMO_CONV_H__
diff --git a/include/osmocom/core/crcXXgen.h.tpl b/include/osmocom/core/crcXXgen.h.tpl
index 89d083ae..a931bc39 100644
--- a/include/osmocom/core/crcXXgen.h.tpl
+++ b/include/osmocom/core/crcXXgen.h.tpl
@@ -28,7 +28,7 @@
  */
 
 /*! \file crcXXgen.h
- *  \file Osmocom generic CRC routines (for max XX bits poly) header
+ * Osmocom generic CRC routines (for max XX bits poly) header
  */
 
 
diff --git a/include/osmocom/core/crcgen.h b/include/osmocom/core/crcgen.h
index 8e208a74..69cef040 100644
--- a/include/osmocom/core/crcgen.h
+++ b/include/osmocom/core/crcgen.h
@@ -28,7 +28,7 @@
  */
 
 /*! \file crcgen.h
- *  \file Osmocom generic CRC routines global header
+ * Osmocom generic CRC routines global header
  */
 
 #include <osmocom/core/crc8gen.h>
diff --git a/include/osmocom/core/gsmtap_util.h b/include/osmocom/core/gsmtap_util.h
index 5609381f..eaa32a00 100644
--- a/include/osmocom/core/gsmtap_util.h
+++ b/include/osmocom/core/gsmtap_util.h
@@ -54,4 +54,6 @@ int gsmtap_send(struct gsmtap_inst *gti, uint16_t arfcn, uint8_t ts,
 		int8_t signal_dbm, uint8_t snr, const uint8_t *data,
 		unsigned int len);
 
+/*! @} */
+
 #endif /* _GSMTAP_UTIL_H */
diff --git a/include/osmocom/core/logging.h b/include/osmocom/core/logging.h
index 655f7a44..54262b7f 100644
--- a/include/osmocom/core/logging.h
+++ b/include/osmocom/core/logging.h
@@ -158,7 +158,7 @@ struct log_target {
 
 	/*! \brief call-back function to be called when the logging framework
 	 *	   wants to log somethnig.
-	 *  \param[[in] target logging target
+	 *  \param[in] target logging target
 	 *  \param[in] level log level of currnet message
 	 *  \param[in] string the string that is to be written to the log
 	 */
diff --git a/include/osmocom/core/msgb.h b/include/osmocom/core/msgb.h
index a1939ab6..fe2733b7 100644
--- a/include/osmocom/core/msgb.h
+++ b/include/osmocom/core/msgb.h
@@ -361,7 +361,7 @@ static inline int msgb_trim(struct msgb *msg, int len)
 }
 
 /*! \brief Trim the msgb to a given layer3 length
- *  \pram[in] msg message buffer
+ *  \param[in] msg message buffer
  *  \param[in] l3len new layer3 length
  *  \returns 0 in case of success, negative in case of error
  */
diff --git a/include/osmocom/core/prim.h b/include/osmocom/core/prim.h
index b1026fe3..f61d8084 100644
--- a/include/osmocom/core/prim.h
+++ b/include/osmocom/core/prim.h
@@ -5,7 +5,7 @@
  *  @{
  */
 
-/*! \file prim.c */
+/*! \file prim.h */
 
 #include <stdint.h>
 #include <osmocom/core/msgb.h>
@@ -37,7 +37,7 @@ struct osmo_prim_hdr {
 /*! \brief initialize a primitive header
  *  \param[in,out] oph primitive header
  *  \param[in] sap Service Access Point
- *  \param[in] primtive Primitive Number
+ *  \param[in] primitive Primitive Number
  *  \param[in] operation Primitive Operation (REQ/RESP/IND/CONF)
  *  \param[in] msg Message
  */
@@ -55,4 +55,6 @@ osmo_prim_init(struct osmo_prim_hdr *oph, unsigned int sap,
 /*! \brief primitive handler callback type */
 typedef int (*osmo_prim_cb)(struct osmo_prim_hdr *oph, void *ctx);
 
+/*! @} */
+
 #endif /* OSMO_PRIMITIVE_H */
diff --git a/include/osmocom/core/serial.h b/include/osmocom/core/serial.h
index 889bd8a1..1640a6da 100644
--- a/include/osmocom/core/serial.h
+++ b/include/osmocom/core/serial.h
@@ -25,7 +25,7 @@
  */
 
 /*! \file serial.h
- *  \file Osmocom serial port helpers
+ * Osmocom serial port helpers
  */
 
 #ifndef __OSMO_SERIAL_H__
diff --git a/include/osmocom/core/statistics.h b/include/osmocom/core/statistics.h
index 04816c16..ade00748 100644
--- a/include/osmocom/core/statistics.h
+++ b/include/osmocom/core/statistics.h
@@ -34,7 +34,7 @@ static inline void osmo_counter_reset(struct osmo_counter *ctr)
 struct osmo_counter *osmo_counter_alloc(const char *name);
 
 /*! \brief Free the specified counter
- *  \param[ctr] Counter
+ *  \param[in] ctr Counter
  */
 void osmo_counter_free(struct osmo_counter *ctr);
 
-- 
cgit v1.2.3