Tidy up SVN docs (#939)

This commit is contained in:
Kamil Tekiela 2021-10-15 15:50:25 +01:00 committed by GitHub
parent 50b104c116
commit b958b68778
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 57 additions and 64 deletions

View file

@ -3,7 +3,7 @@
<refentry xml:id="function.svn-fs-abort-txn" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>svn_fs_abort_txn</refname>
<refpurpose>Abort a transaction, returns true if everything is okay, false otherwise</refpurpose>
<refpurpose>Aborts a transaction</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -14,10 +14,10 @@
</methodsynopsis>
&warn.undocumented.func;
<para>
Abort a transaction, returns true if everything is okay, false otherwise
Aborts a transaction.
</para>
</refsect1>
<!--
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -26,22 +26,21 @@
<term><parameter>txn</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
-->
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;

View file

@ -3,7 +3,7 @@
<refentry xml:id="function.svn-fs-copy" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>svn_fs_copy</refname>
<refpurpose>Copies a file or a directory, returns true if all is ok, false otherwise</refpurpose>
<refpurpose>Copies a file or a directory</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -17,10 +17,10 @@
</methodsynopsis>
&warn.undocumented.func;
<para>
Copies a file or a directory, returns true if all is ok, false otherwise
Copies a file or a directory.
</para>
</refsect1>
<!--
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -29,7 +29,7 @@
<term><parameter>from_root</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
@ -37,7 +37,7 @@
<term><parameter>from_path</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
@ -45,7 +45,7 @@
<term><parameter>to_root</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
@ -53,22 +53,21 @@
<term><parameter>to_path</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
-->
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;

View file

@ -3,7 +3,7 @@
<refentry xml:id="function.svn-fs-delete" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>svn_fs_delete</refname>
<refpurpose>Deletes a file or a directory, return true if all is ok, false otherwise</refpurpose>
<refpurpose>Deletes a file or a directory</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -15,10 +15,10 @@
</methodsynopsis>
&warn.undocumented.func;
<para>
Deletes a file or a directory, return true if all is ok, false otherwise
Deletes a file or a directory.
</para>
</refsect1>
<!--
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -27,7 +27,7 @@
<term><parameter>root</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
@ -35,22 +35,21 @@
<term><parameter>path</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
-->
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;

View file

@ -3,7 +3,7 @@
<refentry xml:id="function.svn-fs-is-dir" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>svn_fs_is_dir</refname>
<refpurpose>Return true if the path points to a directory, false otherwise</refpurpose>
<refpurpose>Determines if a path points to a directory</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -15,10 +15,10 @@
</methodsynopsis>
&warn.undocumented.func;
<para>
Return true if the path points to a directory, false otherwise
Determines if the given path points to a directory.
</para>
</refsect1>
<!--
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -27,7 +27,7 @@
<term><parameter>root</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
@ -35,22 +35,21 @@
<term><parameter>path</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
Returns &true; if the path points to a directory, &false; otherwise.
</para>
</refsect1>
-->
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;

View file

@ -3,7 +3,7 @@
<refentry xml:id="function.svn-fs-is-file" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>svn_fs_is_file</refname>
<refpurpose>Return true if the path points to a file, false otherwise</refpurpose>
<refpurpose>Determines if a path points to a file</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -15,10 +15,10 @@
</methodsynopsis>
&warn.undocumented.func;
<para>
Return true if the path points to a file, false otherwise
Determines if the given path points to a file.
</para>
</refsect1>
<!--
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -27,7 +27,7 @@
<term><parameter>root</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
@ -35,22 +35,21 @@
<term><parameter>path</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
Returns &true; if the path points to a file, &false; otherwise.
</para>
</refsect1>
-->
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;

View file

@ -3,7 +3,7 @@
<refentry xml:id="function.svn-fs-make-dir" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>svn_fs_make_dir</refname>
<refpurpose>Creates a new empty directory, returns true if all is ok, false otherwise</refpurpose>
<refpurpose>Creates a new empty directory</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -15,10 +15,10 @@
</methodsynopsis>
&warn.undocumented.func;
<para>
Creates a new empty directory, returns true if all is ok, false otherwise
Creates a new empty directory.
</para>
</refsect1>
<!--
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -27,7 +27,7 @@
<term><parameter>root</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
@ -35,22 +35,21 @@
<term><parameter>path</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
-->
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;

View file

@ -3,7 +3,7 @@
<refentry xml:id="function.svn-fs-make-file" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>svn_fs_make_file</refname>
<refpurpose>Creates a new empty file, returns true if all is ok, false otherwise</refpurpose>
<refpurpose>Creates a new empty file</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -15,10 +15,10 @@
</methodsynopsis>
&warn.undocumented.func;
<para>
Creates a new empty file, returns true if all is ok, false otherwise
Creates a new empty file.
</para>
</refsect1>
<!--
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@ -27,7 +27,7 @@
<term><parameter>root</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
@ -35,22 +35,21 @@
<term><parameter>path</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure. See
also the &amp;return.success; entity
&return.success;
</para>
</refsect1>
-->
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;