Change in libosmo-abis[master]: e1_input: Document e1inp_line_create()

[pespin]

pespin has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-abis/+/25546 )

Change subject: e1_input: Document e1inp_line_create()
......................................................................

e1_input: Document e1inp_line_create()

Specially important regarding the pre-allocated reference count.
This was done when moving the API to use osmo_use_count internally,
because previous code already came with refcount=1.

Change-Id: I819a13732c5d0ff150bc11d1cfd64e96ee81bad2
---
M src/e1_input.c
1 file changed, 8 insertions(+), 0 deletions(-)

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



diff --git a/src/e1_input.c b/src/e1_input.c
index fd3082e..9fb8a3b 100644
--- a/src/e1_input.c
+++ b/src/e1_input.c
@@ -470,6 +470,14 @@
 	return NULL;
 }
 
+/*! Create a new e1inp line object.
+ * \param[in] e1_nr The line number of the new line to be created.
+ * \param[in] driver_name String identifying the driver (see e1inp_driver_register() for more info).
+ * \returns pointer to the new object created.
+ *
+ * The allocated object is returned with a count reference with name "ctor",
+ * which must be dropped in order to free the object [e1inp_line_put2(line, "ctor")].
+ */
 struct e1inp_line *
 e1inp_line_create(uint8_t e1_nr, const char *driver_name)
 {

-- 
To view, visit https://gerrit.osmocom.org/c/libosmo-abis/+/25546
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: libosmo-abis
Gerrit-Branch: master
Gerrit-Change-Id: I819a13732c5d0ff150bc11d1cfd64e96ee81bad2
Gerrit-Change-Number: 25546
Gerrit-PatchSet: 1
Gerrit-Owner: pespin <pespin at sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: fixeria <vyanitskiy 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/20210923/4ea2fd19/attachment.htm>