cellular-infrastructure
/
osmo-mgw
mirror of https://gerrit.osmocom.org/osmo-mgw
10
0
Fork 0
Code Issues Releases Wiki Activity

mgcp_client_vty: add missing docstrings 

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

Change-Id: Ia7ca2e4a8efa714f7a56ffd18de152c992936221
This commit is contained in:
Philipp Maier 2021-08-03 16:03:27 +02:00
parent 3f4a4cb49c
commit d6a7e17911
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/libosmo-mgcp-client/mgcp_client_vty.c
View File

@ -270,6 +270,10 @@ static int config_write(struct vty *vty, const char *indent, struct mgcp_client_
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 @@ static void vty_init_common(void *talloc_ctx, int node)
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;