laforge has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-netif/+/36292?usp=email )
Change subject: docs: Don't export documentation about static (internal) functions
......................................................................
docs: Don't export documentation about static (internal) functions
The generated API documentation should be relevant to the API user,
and hence only non-static/public functions are relevant
Change-Id: I6fee052ad22877db85fe3207c7eac950d875873b
---
M Doxyfile.in
1 file changed, 13 insertions(+), 1 deletion(-)
Approvals:
Jenkins Builder: Verified
pespin: Looks good to me, but someone else must approve
fixeria: Looks good to me, approved
diff --git a/Doxyfile.in b/Doxyfile.in
index a7fe3ad..001a085 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -328,7 +328,7 @@
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
-EXTRACT_STATIC = YES
+EXTRACT_STATIC = NO
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
--
To view, visit https://gerrit.osmocom.org/c/libosmo-netif/+/36292?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: libosmo-netif
Gerrit-Branch: master
Gerrit-Change-Id: I6fee052ad22877db85fe3207c7eac950d875873b
Gerrit-Change-Number: 36292
Gerrit-PatchSet: 3
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de>
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>
Gerrit-MessageType: merged
laforge has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-netif/+/36290?usp=email )
Change subject: docs: Enable AUTOBRIEF feauture in doxygen
......................................................................
docs: Enable AUTOBRIEF feauture in doxygen
We have that enabled in libosmcore.git for ages, somehow we missed
it here, resulting in missing 'brief' descriptions in the output.
Change-Id: I751036baa9a2b30d94a2a302c7072a5487d2c26e
---
M Doxyfile.in
1 file changed, 14 insertions(+), 2 deletions(-)
Approvals:
Jenkins Builder: Verified
fixeria: Looks good to me, approved
pespin: Looks good to me, but someone else must approve
diff --git a/Doxyfile.in b/Doxyfile.in
index 3843f79..a7fe3ad 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -150,7 +150,7 @@
# comments will behave just like regular Qt-style comments
# (thus requiring an explicit @brief command for a brief description.)
-JAVADOC_AUTOBRIEF = NO
+JAVADOC_AUTOBRIEF = YES
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
@@ -158,7 +158,7 @@
# will behave just like regular Qt-style comments (thus requiring
# an explicit \brief command for a brief description.)
-QT_AUTOBRIEF = NO
+QT_AUTOBRIEF = YES
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
--
To view, visit https://gerrit.osmocom.org/c/libosmo-netif/+/36290?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: libosmo-netif
Gerrit-Branch: master
Gerrit-Change-Id: I751036baa9a2b30d94a2a302c7072a5487d2c26e
Gerrit-Change-Number: 36290
Gerrit-PatchSet: 2
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de>
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>
Gerrit-MessageType: merged
laforge has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-netif/+/36291?usp=email )
Change subject: docs: Use \defgroup and avoid repeated boilerplate text
......................................................................
docs: Use \defgroup and avoid repeated boilerplate text
Change-Id: I1196c3b035f495c5dbaa4d47ce3f79a08d0727f2
---
M include/osmocom/netif/stream.h
M src/stream.c
M src/stream_cli.c
M src/stream_srv.c
4 files changed, 20 insertions(+), 17 deletions(-)
Approvals:
pespin: Looks good to me, but someone else must approve
fixeria: Looks good to me, approved
Jenkins Builder: Verified
diff --git a/include/osmocom/netif/stream.h b/include/osmocom/netif/stream.h
index fe4dd77..96633d6 100644
--- a/include/osmocom/netif/stream.h
+++ b/include/osmocom/netif/stream.h
@@ -6,8 +6,15 @@
#include <osmocom/core/msgb.h>
-/*! \addtogroup stream
+/*! \defgroup stream Osmocom Stream Server/Client
* @{
+ *
+ * This code is intended to abstract any use of stream-type sockets,
+ * such as TCP and SCTP. It offers both server and client side
+ * implementations, fully integrated with the libosmocore select loop
+ * abstraction.
+ *
+ * \file stream.h
*/
/*! \brief Access SCTP flags from the msgb control buffer */
diff --git a/src/stream.c b/src/stream.c
index f4755e0..60a7623 100644
--- a/src/stream.c
+++ b/src/stream.c
@@ -52,13 +52,8 @@
#include <osmocom/netif/sctp.h>
-/*! \addtogroup stream Osmocom Stream Socket
+/*! \addtogroup stream
* @{
- *
- * This code is intended to abstract any use of stream-type sockets,
- * such as TCP and SCTP. It offers both server and client side
- * implementations, fully integrated with the libosmocore select loop
- * abstraction.
*/
/*! \file stream.c
diff --git a/src/stream_cli.c b/src/stream_cli.c
index 46ddc89..9c3f65a 100644
--- a/src/stream_cli.c
+++ b/src/stream_cli.c
@@ -52,12 +52,8 @@
#include <osmocom/netif/sctp.h>
-/*! \addtogroup stream Osmocom Stream Socket (client side)
+/*! \addtogroup stream
* @{
- *
- * This code is intended to abstract any use of stream-type sockets,
- * such as TCP and SCTP. It offers client side implementation,
- * fully integrated with the libosmocore select loop abstraction.
*/
/*! \file stream_cli.c
diff --git a/src/stream_srv.c b/src/stream_srv.c
index da49bad..58ed7ef 100644
--- a/src/stream_srv.c
+++ b/src/stream_srv.c
@@ -53,12 +53,8 @@
#include <osmocom/netif/sctp.h>
-/*! \addtogroup stream Osmocom Stream Socket (server side)
+/*! \addtogroup stream
* @{
- *
- * This code is intended to abstract any use of stream-type sockets,
- * such as TCP and SCTP. It offers server side implementation,
- * fully integrated with the libosmocore select loop abstraction.
*/
/*! \file stream_srv.c
--
To view, visit https://gerrit.osmocom.org/c/libosmo-netif/+/36291?usp=email
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings
Gerrit-Project: libosmo-netif
Gerrit-Branch: master
Gerrit-Change-Id: I1196c3b035f495c5dbaa4d47ce3f79a08d0727f2
Gerrit-Change-Number: 36291
Gerrit-PatchSet: 3
Gerrit-Owner: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de>
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: pespin <pespin(a)sysmocom.de>
Gerrit-MessageType: merged