svn: /phpdoc/ja/trunk/reference/ apache/functions/apache-child-terminate.xml apache/functions/apache-getenv.xml apache/functions/apache-lookup-uri.xml apache/functions/apache-note.xml apache/functions/virtual.xml info/functions/cli-get-process-title.xml

[email protected] (Yoshinari Takaoka) Sat, 26 Dec 2020 21:12:30 +0000
Newsgroups php.doc.ja
Message-ID <[email protected]>
mumumu                                   Sat, 26 Dec 2020 21:12:30 +0000

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

Log:
Generate sapi methodsynopses based on stubs

Closes GH-285.

Changed paths:
    U   phpdoc/ja/trunk/reference/apache/functions/apache-child-terminate.xml
    U   phpdoc/ja/trunk/reference/apache/functions/apache-getenv.xml
    U   phpdoc/ja/trunk/reference/apache/functions/apache-lookup-uri.xml
    U   phpdoc/ja/trunk/reference/apache/functions/apache-note.xml
    U   phpdoc/ja/trunk/reference/apache/functions/virtual.xml
    U   phpdoc/ja/trunk/reference/info/functions/cli-get-process-title.xml
svn-diffs-352194.txt (text/x-diff, 10.3 KB)
Modified: phpdoc/ja/trunk/reference/apache/functions/apache-child-terminate.xml
===================================================================
--- phpdoc/ja/trunk/reference/apache/functions/apache-child-terminate.xml	2020-12-26 21:04:20 UTC (rev 352193)
+++ phpdoc/ja/trunk/reference/apache/functions/apache-child-terminate.xml	2020-12-26 21:12:30 UTC (rev 352194)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 350656 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 352190 Maintainer: hirokawa Status: ready -->
 <!-- CREDITS: shimooka,mumumu -->
 <refentry xml:id="function.apache-child-terminate" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -11,7 +11,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>bool</type><methodname>apache_child_terminate</methodname>
+   <type>void</type><methodname>apache_child_terminate</methodname>
    <void/>
   </methodsynopsis>
   <para>
@@ -31,12 +31,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   もし PHP が Apache 1 モジュールとして実行している場合、&true; を返します。
-   この Apache バージョンはマルチスレッドバージョンではなく、
-   <link linkend="ini.child-terminate">child_terminate</link> PHP
-   ディレクティブは有効です (デフォルトは無効) 。
-   もしこれらの条件に適合しない場合 &false; が返され、エラーレベル
-   <constant>E_WARNING</constant> が発生します。
+   &return.void;
   </para>
  </refsect1>

@@ -54,7 +49,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/apache/functions/apache-getenv.xml
===================================================================
--- phpdoc/ja/trunk/reference/apache/functions/apache-getenv.xml	2020-12-26 21:04:20 UTC (rev 352193)
+++ phpdoc/ja/trunk/reference/apache/functions/apache-getenv.xml	2020-12-26 21:12:30 UTC (rev 352194)
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 351730 Maintainer: shimooka Status: ready -->
+<!-- EN-Revision: 352190 Maintainer: shimooka Status: ready -->
+<!-- Credits: mumumu -->
 <refentry xml:id="function.apache-getenv" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>apache_getenv</refname>
@@ -10,7 +11,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>string</type><methodname>apache_getenv</methodname>
+   <type class="union"><type>string</type><type>false</type></type><methodname>apache_getenv</methodname>
    <methodparam><type>string</type><parameter>variable</parameter></methodparam>
    <methodparam choice="opt"><type>bool</type><parameter>walk_to_top</parameter><initializer>&false;</initializer></methodparam>
   </methodsynopsis>
@@ -17,9 +18,6 @@
   <para>
    <parameter>variable</parameter> で指定された Apache 環境変数を取得します。
   </para>
-  <para>
-   この関数は Apache 2 を必要とします。それ以外では定義されていません。
-  </para>
  </refsect1>

  <refsect1 role="parameters">
@@ -92,7 +90,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/apache/functions/apache-lookup-uri.xml
===================================================================
--- phpdoc/ja/trunk/reference/apache/functions/apache-lookup-uri.xml	2020-12-26 21:04:20 UTC (rev 352193)
+++ phpdoc/ja/trunk/reference/apache/functions/apache-lookup-uri.xml	2020-12-26 21:12:30 UTC (rev 352194)
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 297028 Maintainer: hirokawa Status: ready -->
-<!-- CREDITS: shimooka -->
+<!-- EN-Revision: 352190 Maintainer: hirokawa Status: ready -->
+<!-- CREDITS: shimooka,mumumu -->
 <refentry xml:id="function.apache-lookup-uri" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>apache_lookup_uri</refname>
@@ -13,7 +13,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>object</type><methodname>apache_lookup_uri</methodname>
+   <type class="union"><type>object</type><type>false</type></type><methodname>apache_lookup_uri</methodname>
    <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -70,6 +70,9 @@
     <member>request_time</member>
    </simplelist>
   </para>
+  <para>
+   失敗時に &false; を返します。
+  </para>
  </refsect1>

  <refsect1 role="examples">
@@ -119,7 +122,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/apache/functions/apache-note.xml
===================================================================
--- phpdoc/ja/trunk/reference/apache/functions/apache-note.xml	2020-12-26 21:04:20 UTC (rev 352193)
+++ phpdoc/ja/trunk/reference/apache/functions/apache-note.xml	2020-12-26 21:12:30 UTC (rev 352194)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 351729 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 352190 Maintainer: hirokawa Status: ready -->
 <!-- Credits: mumumu -->
 <refentry xml:id="function.apache-note" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -11,14 +11,10 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>string</type><methodname>apache_note</methodname>
+   <type class="union"><type>string</type><type>false</type></type><methodname>apache_note</methodname>
    <methodparam><type>string</type><parameter>note_name</parameter></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>note_value</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
-  <methodsynopsis>
-   <type>string</type><methodname>apache_note</methodname>
-   <methodparam><type>string</type><parameter>note_name</parameter></methodparam>
-   <methodparam><type>string</type><parameter>note_value</parameter></methodparam>
-  </methodsynopsis>
   <para>
    この関数は、Apache の <literal>table_get</literal> および
    <literal>table_set</literal> のラッパーです。
@@ -58,9 +54,9 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   引数が1つだけ指定されてコールされた場合、
-   現在の記号の値<literal>note_name</literal>が返されます。
-   引数が2つ指定されてコールされた場合、記号<literal>note_name</literal>
+   <parameter>note_value</parameter> が省略されるか、&null; の場合、
+   <literal>note_name</literal> の現在の値が返されます。
+   そうでない場合、記号<literal>note_name</literal>
    の値を<literal>note_value</literal>にセットし、前の記号
    <literal>note_name</literal>の値を返します。
    もし記号が処理できない場合、&false; が返されます。
@@ -67,6 +63,28 @@
   </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>note_value</parameter> は、nullable になりました。
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
@@ -132,7 +150,6 @@
  </refsect1>

 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/apache/functions/virtual.xml
===================================================================
--- phpdoc/ja/trunk/reference/apache/functions/virtual.xml	2020-12-26 21:04:20 UTC (rev 352193)
+++ phpdoc/ja/trunk/reference/apache/functions/virtual.xml	2020-12-26 21:12:30 UTC (rev 352194)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$-->
-<!-- EN-Revision: 338550 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 352190 Maintainer: hirokawa Status: ready -->
 <!-- CREDITS: shimooka,takagi -->
 <refentry xml:id="function.virtual" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -12,7 +12,7 @@
   &reftitle.description;
   <methodsynopsis>
    <type>bool</type><methodname>virtual</methodname>
-   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
+   <methodparam><type>string</type><parameter>uri</parameter></methodparam>
   </methodsynopsis>
   <para>
    <function>virtual</function> は、<literal>mod_include</literal> の
@@ -37,7 +37,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>filename</parameter></term>
+     <term><parameter>uri</parameter></term>
      <listitem>
       <para>
        virtual コマンドが実行されるファイル
@@ -99,7 +99,6 @@
  </refsect1>

 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/info/functions/cli-get-process-title.xml
===================================================================
--- phpdoc/ja/trunk/reference/info/functions/cli-get-process-title.xml	2020-12-26 21:04:20 UTC (rev 352193)
+++ phpdoc/ja/trunk/reference/info/functions/cli-get-process-title.xml	2020-12-26 21:12:30 UTC (rev 352194)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 351730 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 352190 Maintainer: takagi Status: ready -->

 <refentry xml:id="function.cli-get-process-title" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -11,8 +11,8 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>string</type><methodname>cli_get_process_title</methodname>
-   <void />
+   <type class="union"><type>string</type><type>null</type></type><methodname>cli_get_process_title</methodname>
+   <void/>
   </methodsynopsis>
   <para>
    現在のプロセスのタイトルを返します。これは
@@ -74,7 +74,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml