Change in osmo-mgw[master]: mgcp_client_vty: add missing docstrings

[laforge]

laforge has submitted this change. ( https://gerrit.osmocom.org/c/osmo-mgw/+/25121 )

Change subject: mgcp_client_vty: add missing docstrings
......................................................................

mgcp_client_vty: add missing docstrings

The VTY for the classic non pooled MGCP Client does not have any API
doctumentation.

Change-Id: Ia7ca2e4a8efa714f7a56ffd18de152c992936221
---
M src/libosmo-mgcp-client/mgcp_client_vty.c
1 file changed, 9 insertions(+), 0 deletions(-)

Approvals:
  Jenkins Builder: Verified
  laforge: Looks good to me, approved
  daniel: Looks good to me, but someone else must approve
  osmith: Looks good to me, but someone else must approve



diff --git a/src/libosmo-mgcp-client/mgcp_client_vty.c b/src/libosmo-mgcp-client/mgcp_client_vty.c
index 68a3208..81ce0e1 100644
--- a/src/libosmo-mgcp-client/mgcp_client_vty.c
+++ b/src/libosmo-mgcp-client/mgcp_client_vty.c
@@ -270,6 +270,10 @@
 	return CMD_SUCCESS;
 }
 
+/*! Write out MGCP client config to VTY.
+ *  \param[in] vty VTY to which we should print.
+ *  \param[in] string used for indentation (e.g. " ").
+ *  \returns CMD_SUCCESS on success, CMD_WARNING on error */
 int mgcp_client_config_write(struct vty *vty, const char *indent)
 {
 	return config_write(vty, indent, global_mgcp_client_conf);
@@ -292,6 +296,11 @@
 	osmo_fsm_vty_add_cmds();
 }
 
+/*! Set up MGCP client VTY
+ *  (called once at startup by the application process).
+ *  \param[in] talloc_ctx talloc context to be used by the VTY for allocating memory.
+ *  \param[in] node identifier of the node on which the VTY commands should be installed.
+ *  \param[in] conf user provided memory to to store the MGCP client configuration data. */
 void mgcp_client_vty_init(void *talloc_ctx, int node, struct mgcp_client_conf *conf)
 {
 	global_mgcp_client_conf = conf;

-- 
To view, visit https://gerrit.osmocom.org/c/osmo-mgw/+/25121
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-mgw
Gerrit-Branch: master
Gerrit-Change-Id: Ia7ca2e4a8efa714f7a56ffd18de152c992936221
Gerrit-Change-Number: 25121
Gerrit-PatchSet: 15
Gerrit-Owner: dexter <pmaier at sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: daniel <dwillmann at sysmocom.de>
Gerrit-Reviewer: laforge <laforge at osmocom.org>
Gerrit-Reviewer: neels <nhofmeyr at sysmocom.de>
Gerrit-Reviewer: osmith <osmith at sysmocom.de>
Gerrit-Reviewer: pespin <pespin at sysmocom.de>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20210817/fd67e4ff/attachment.htm>