svn: /phpdoc/ja/trunk/reference/readline/functions/ readline-add-history.xml readline-completion-function.xml readline-info.xml readline-read-history.xml readline-write-history.xml readline.xml

[email protected] (Yoshinari Takaoka)
Newsgroups php.doc.ja
Message-ID <[email protected]>
mumumu                                   Tue, 24 Nov 2020 23:07:05 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=351611

Log:
Generate readline methodsynopses based on stubs

Based on a patch contributed by Máté Kocsis <[email protected]>.

Changed paths:
    U   phpdoc/ja/trunk/reference/readline/functions/readline-add-history.xml
    U   phpdoc/ja/trunk/reference/readline/functions/readline-completion-function.xml
    U   phpdoc/ja/trunk/reference/readline/functions/readline-info.xml
    U   phpdoc/ja/trunk/reference/readline/functions/readline-read-history.xml
    U   phpdoc/ja/trunk/reference/readline/functions/readline-write-history.xml
    U   phpdoc/ja/trunk/reference/readline/functions/readline.xml
svn-diffs-351611.txt (text/x-diff, 10.6 KB)
Modified: phpdoc/ja/trunk/reference/readline/functions/readline-add-history.xml
===================================================================
--- phpdoc/ja/trunk/reference/readline/functions/readline-add-history.xml	2020-11-24 23:03:25 UTC (rev 351610)
+++ phpdoc/ja/trunk/reference/readline/functions/readline-add-history.xml	2020-11-24 23:07:05 UTC (rev 351611)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 297028 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351551 Maintainer: hirokawa Status: ready -->
 <!-- CREDITS: takagi -->
 <refentry xml:id="function.readline-add-history" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -12,7 +12,7 @@
   &reftitle.description;
   <methodsynopsis>
    <type>bool</type><methodname>readline_add_history</methodname>
-   <methodparam><type>string</type><parameter>line</parameter></methodparam>
+   <methodparam><type>string</type><parameter>prompt</parameter></methodparam>
   </methodsynopsis>
   <para>
    この関数は、コマンドラインヒストリに 1 行追加します。
@@ -24,7 +24,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>line</parameter></term>
+     <term><parameter>prompt</parameter></term>
      <listitem>
       <para>
        ヒストリに追加する行。
@@ -42,7 +42,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/readline/functions/readline-completion-function.xml
===================================================================
--- phpdoc/ja/trunk/reference/readline/functions/readline-completion-function.xml	2020-11-24 23:03:25 UTC (rev 351610)
+++ phpdoc/ja/trunk/reference/readline/functions/readline-completion-function.xml	2020-11-24 23:07:05 UTC (rev 351611)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 324122 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 351551 Maintainer: takagi Status: ready -->
 <!-- CREDITS: hirokawa -->
 <refentry xml:id="function.readline-completion-function" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -12,7 +12,7 @@
   &reftitle.description;
   <methodsynopsis>
    <type>bool</type><methodname>readline_completion_function</methodname>
-   <methodparam><type>callable</type><parameter>function</parameter></methodparam>
+   <methodparam><type>callable</type><parameter>callback</parameter></methodparam>
   </methodsynopsis>
   <para>
    この関数は補完用の関数を登録します。
@@ -26,7 +26,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>function</parameter></term>
+     <term><parameter>callback</parameter></term>
      <listitem>
       <para>
        コマンドラインの一部を入力とし、
@@ -46,7 +46,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/readline/functions/readline-info.xml
===================================================================
--- phpdoc/ja/trunk/reference/readline/functions/readline-info.xml	2020-11-24 23:03:25 UTC (rev 351610)
+++ phpdoc/ja/trunk/reference/readline/functions/readline-info.xml	2020-11-24 23:07:05 UTC (rev 351611)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 297028 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351551 Maintainer: hirokawa Status: ready -->
 <!-- CREDITS: takagi -->
 <refentry xml:id="function.readline-info" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -12,8 +12,8 @@
   &reftitle.description;
   <methodsynopsis>
    <type>mixed</type><methodname>readline_info</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>varname</parameter></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>newvalue</parameter></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>var_name</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>int</type><type>string</type><type>bool</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
   <para>
    さまざまな readline の内部変数の取得あるいは設定を行います。
@@ -25,7 +25,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>varname</parameter></term>
+     <term><parameter>var_name</parameter></term>
      <listitem>
       <para>
        変数の名前。
@@ -33,7 +33,7 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>newvalue</parameter></term>
+     <term><parameter>value</parameter></term>
      <listitem>
       <para>
        指定した場合は、これがその設定の新しい値となります。
@@ -59,8 +59,30 @@
   </para>
  </refsect1>

+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.0.0</entry>
+      <entry>
+       <parameter>var_name</parameter> と <parameter>value</parameter> は、
+       nullable になりました。
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/readline/functions/readline-read-history.xml
===================================================================
--- phpdoc/ja/trunk/reference/readline/functions/readline-read-history.xml	2020-11-24 23:03:25 UTC (rev 351610)
+++ phpdoc/ja/trunk/reference/readline/functions/readline-read-history.xml	2020-11-24 23:07:05 UTC (rev 351611)
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 297028 Maintainer: hirokawa Status: ready -->
-<!-- CREDITS: takagi -->
+<!-- EN-Revision: 351551 Maintainer: hirokawa Status: ready -->
+<!-- CREDITS: takagi,mumumu -->
 <refentry xml:id="function.readline-read-history" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>readline_read_history</refname>
@@ -12,7 +12,7 @@
   &reftitle.description;
   <methodsynopsis>
    <type>bool</type><methodname>readline_read_history</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>filename</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
   <para>
    この関数は、コマンドヒストリをファイルから読み込みます。
@@ -42,8 +42,29 @@
   </para>
  </refsect1>

+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.0.0</entry>
+      <entry>
+       <parameter>filename</parameter> は、nullable になりました。
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/readline/functions/readline-write-history.xml
===================================================================
--- phpdoc/ja/trunk/reference/readline/functions/readline-write-history.xml	2020-11-24 23:03:25 UTC (rev 351610)
+++ phpdoc/ja/trunk/reference/readline/functions/readline-write-history.xml	2020-11-24 23:07:05 UTC (rev 351611)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 297028 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351551 Maintainer: hirokawa Status: ready -->
 <!-- CREDITS: takagi -->
 <refentry xml:id="function.readline-write-history" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -12,7 +12,7 @@
   &reftitle.description;
   <methodsynopsis>
    <type>bool</type><methodname>readline_write_history</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>filename</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
   <para>
    この関数はコマンドヒストリをファイルに書き込みます。
@@ -41,8 +41,30 @@
    &return.success;
   </para>
  </refsect1>
+
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.0.0</entry>
+      <entry>
+       <parameter>filename</parameter> は、nullable になりました。
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/readline/functions/readline.xml
===================================================================
--- phpdoc/ja/trunk/reference/readline/functions/readline.xml	2020-11-24 23:03:25 UTC (rev 351610)
+++ phpdoc/ja/trunk/reference/readline/functions/readline.xml	2020-11-24 23:07:05 UTC (rev 351611)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 349481 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351551 Maintainer: hirokawa Status: ready -->
 <!-- CREDITS: takagi -->
 <refentry xml:id="function.readline" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -11,8 +11,8 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>string</type><methodname>readline</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>prompt</parameter><initializer>&null;</initializer></methodparam>
+   <type class="union"><type>string</type><type>false</type></type><methodname>readline</methodname>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>prompt</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
   <para>
    ユーザーからの入力を一行読み込みます。
@@ -73,7 +73,6 @@
  </refsect1>

 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.