[sr-dev] git:master:49d43d78: ss7ops: fix the dobook markdown and properly named the sections

Daniel-Constantin Mierla miconda at gmail.com
Thu Dec 1 12:38:34 CET 2016


Module: kamailio
Branch: master
Commit: 49d43d789eb0cecdfd60c5c43a0cf478e101cd47
URL: https://github.com/kamailio/kamailio/commit/49d43d789eb0cecdfd60c5c43a0cf478e101cd47

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2016-12-01T12:37:39+01:00

ss7ops: fix the dobook markdown and properly named the sections

---

Modified: modules/ss7ops/doc/ss7ops_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/49d43d789eb0cecdfd60c5c43a0cf478e101cd47.diff
Patch: https://github.com/kamailio/kamailio/commit/49d43d789eb0cecdfd60c5c43a0cf478e101cd47.patch

---

diff --git a/modules/ss7ops/doc/ss7ops_admin.xml b/modules/ss7ops/doc/ss7ops_admin.xml
index f38ee6c..fc28573 100644
--- a/modules/ss7ops/doc/ss7ops_admin.xml
+++ b/modules/ss7ops/doc/ss7ops_admin.xml
@@ -35,26 +35,37 @@
 			</itemizedlist>
 		</para>
 	</section>
-	</section>
 	<section>
-	<title>Parameters</title>
-	<section id="ss7ops.p.isup_to_json">
-		<title><varname>isup_to_json</varname> (integer)</title>
+	<title>Functions</title>
+	<section id="ss7ops.f.isup_to_json">
+		<function moreinfo="none">isup_to_json(proto)</function>
+		<title><varname>isup_to_json</varname></title>
+		<para>
+		Pass the HEP protocol type as parameter (e.g. 8 for M2UA) and the
+		contained ISUP payload will be converted to a JSON string. The result
+		can be accessed using the $isup(1) variable.
+		</para>
 		<para>
-		Pass the HEP type as parameter (e.g. 8 for M2UA) and the contained
-		ISUP payload will be converted to a JSON string. It can be consumed
-		using the $isup(1) parameter.
+		<example>
+		<title><function>isup_to_json</function> usage</title>
+		<programlisting format="linespecific">
+...
+isup_to_json(8);
+...
+</programlisting>
+	    </example>
 		</para>
 	</section>
 	</section>
 	<section>
-	<title>Functions</title>
+	<title>Variables</title>
 	<section id="ss7ops.f.isup">
-		<title><varname>isup</varname> (integer)</title>
+		<title><varname>isup(id)</varname></title>
 		<para>
-		If set to 1, return the JSON representation as string for the last
+		If id is set to 1, return the JSON representation as string for the last
 		message that was parsed.
 		</para>
 	</section>
+	</section>
 
 </chapter>




More information about the sr-dev mailing list