manual: document new function

also add documentation for undocumented function
This commit is contained in:
Daniel Kochmański 2016-10-05 13:51:36 +02:00
parent 0badafcd35
commit 8cd2e19747

View file

@ -72,6 +72,39 @@
</refentry>
<!-- ====================================================================== -->
<!-- MP:HOLDING-LOCK-P -->
<!-- ====================================================================== -->
<refentry xml:id="ref.mp.holding-lock-p">
<refnamediv>
<refname><function>mp:holding-lock-p</function></refname>
<refpurpose>Determine whether current process holds the lock.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Function</title>
<funcsynopsis>
<funcprototype>
<funcdef>mp:holding-lock-p</funcdef>
<paramdef><parameter>lock</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><replaceable>lock</replaceable></term>
<listitem><para>An object of type <replaceable>mp:lock</replaceable>.</para></listitem>
</varlistentry>
</variablelist>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>Returns true if the current process holds the lock.</para>
</refsect1>
</refentry>
<!-- ====================================================================== -->
<!-- MP:INTERRUPT-PROCESS -->
<!-- ====================================================================== -->
@ -453,7 +486,7 @@
<title>Function</title>
<funcsynopsis>
<funcprototype>
<funcdef>mp:process-active-p</funcdef>
<funcdef>mp:process-name</funcdef>
<paramdef><parameter>process</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@ -588,6 +621,39 @@
</refsect1>
</refentry>
<!-- ====================================================================== -->
<!-- MP:RECURSIVE-LOCK-P -->
<!-- ====================================================================== -->
<refentry xml:id="ref.mp.recursive-lock-p">
<refnamediv>
<refname><function>mp:recursive-lock-p</function></refname>
<refpurpose>Determine whether lock is recursive or not.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Function</title>
<funcsynopsis>
<funcprototype>
<funcdef>mp:recursive-lock-p</funcdef>
<paramdef><parameter>lock</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><replaceable>lock</replaceable></term>
<listitem><para>An object of type <replaceable>mp:lock</replaceable>.</para></listitem>
</varlistentry>
</variablelist>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>Returns true if the lock is recursive.</para>
</refsect1>
</refentry>
<!-- ====================================================================== -->
<!-- MP:WITH-LOCK -->
<!-- ====================================================================== -->
@ -652,4 +718,4 @@
nxml-outline-child-indent: 1
fill-column: 79
End:
-->
-->