michael Mon Oct 10 09:57:43 2005 EDT
Modified files:
/phpdoc/en/reference/newt/functions newt-centered-window.xml
newt-open-window.xml
newt-pop-window.xml
Log:
documented basic Window functions.
http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-centered-window.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/newt/functions/newt-centered-window.xml
diff -u phpdoc/en/reference/newt/functions/newt-centered-window.xml:1.2
phpdoc/en/reference/newt/functions/newt-centered-window.xml:1.3
--- phpdoc/en/reference/newt/functions/newt-centered-window.xml:1.2 Mon Oct
10 08:07:55 2005
+++ phpdoc/en/reference/newt/functions/newt-centered-window.xml Mon Oct 10
09:57:41 2005
@@ -1,21 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.newt-centered-window">
<refnamediv>
<refname>newt_centered_window</refname>
- <refpurpose></refpurpose>
+ <refpurpose>Open a centered window of the specified size</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <type>void</type><methodname>newt_centered_window</methodname>
+ <type>int</type><methodname>newt_centered_window</methodname>
<methodparam><type>int</type><parameter>width</parameter></methodparam>
<methodparam><type>int</type><parameter>height</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>title</parameter></methodparam>
</methodsynopsis>
-
- &warn.undocumented.func;
-
+ <para>Open a centered window of the specified size.</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -25,7 +23,7 @@
<term><parameter>width</parameter></term>
<listitem>
<para>
- Its description
+ Window width
</para>
</listitem>
</varlistentry>
@@ -33,7 +31,7 @@
<term><parameter>height</parameter></term>
<listitem>
<para>
- Its description
+ Window height
</para>
</listitem>
</varlistentry>
@@ -41,7 +39,7 @@
<term><parameter>title</parameter></term>
<listitem>
<para>
- Its description
+ Window title
</para>
</listitem>
</varlistentry>
@@ -51,90 +49,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- What the function returns, first on success, then on failure. See
- also the &return.success; entity
- </para>
- </refsect1>
-
- <!-- Use when EXCEPTIONS exist
- <refsect1 role="exceptions">
- &reftitle.exceptions;
- <para>
- When does this function throw exceptions?
- </para>
- </refsect1>
- -->
-
-
- <!-- Use when a CHANGELOG exists
- <refsect1 role="changelog">
- &reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Enter the PHP version of change here</entry>
- <entry>Description of change</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ Undefined value.
</para>
</refsect1>
- -->
-
- <!-- Use when examples exist
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title>A <function>newt_centered_window</function> example</title>
- <para>
- Any text that describes the purpose of the example, or
- what goes on in the example should go here (inside the
- <example> tag, not out
- </para>
- <programlisting role="php">
-<![CDATA[
-<?php
-if ($anexample === true) {
- echo 'Use the PEAR Coding Standards';
-}
-?>
-]]>
- </programlisting>
- &example.outputs;
- <screen>
-<![CDATA[
-Use the PEAR Coding Standards
-]]>
- </screen>
- </example>
- </para>
- </refsect1>
- -->
-
-
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>newt_pop_window</function></member>
+ <member><function>newt_open_window</function></member>
</simplelist>
</para>
</refsect1>
- -->
-
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-open-window.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/newt/functions/newt-open-window.xml
diff -u phpdoc/en/reference/newt/functions/newt-open-window.xml:1.2
phpdoc/en/reference/newt/functions/newt-open-window.xml:1.3
--- phpdoc/en/reference/newt/functions/newt-open-window.xml:1.2 Mon Oct 10
08:07:56 2005
+++ phpdoc/en/reference/newt/functions/newt-open-window.xml Mon Oct 10
09:57:42 2005
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.newt-open-window">
<refnamediv>
<refname>newt_open_window</refname>
- <refpurpose></refpurpose>
+ <refpurpose>Open a window of the specified size and position</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@@ -15,9 +15,9 @@
<methodparam><type>int</type><parameter>height</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>title</parameter></methodparam>
</methodsynopsis>
-
- &warn.undocumented.func;
-
+ <para>
+ Open a window of the specified size and position.
+ </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -27,7 +27,7 @@
<term><parameter>left</parameter></term>
<listitem>
<para>
- Its description
+ Location of the upper left-hand corner of the window (column number)
</para>
</listitem>
</varlistentry>
@@ -35,7 +35,7 @@
<term><parameter>top</parameter></term>
<listitem>
<para>
- Its description
+ Location of the upper left-hand corner of the window (row number)
</para>
</listitem>
</varlistentry>
@@ -43,7 +43,7 @@
<term><parameter>width</parameter></term>
<listitem>
<para>
- Its description
+ Window width
</para>
</listitem>
</varlistentry>
@@ -51,7 +51,7 @@
<term><parameter>height</parameter></term>
<listitem>
<para>
- Its description
+ Window height
</para>
</listitem>
</varlistentry>
@@ -59,7 +59,7 @@
<term><parameter>title</parameter></term>
<listitem>
<para>
- Its description
+ Window title
</para>
</listitem>
</varlistentry>
@@ -69,90 +69,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- What the function returns, first on success, then on failure. See
- also the &return.success; entity
- </para>
- </refsect1>
-
- <!-- Use when EXCEPTIONS exist
- <refsect1 role="exceptions">
- &reftitle.exceptions;
- <para>
- When does this function throw exceptions?
- </para>
- </refsect1>
- -->
-
-
- <!-- Use when a CHANGELOG exists
- <refsect1 role="changelog">
- &reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Enter the PHP version of change here</entry>
- <entry>Description of change</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- </refsect1>
- -->
-
-
- <!-- Use when examples exist
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title>A <function>newt_open_window</function> example</title>
- <para>
- Any text that describes the purpose of the example, or
- what goes on in the example should go here (inside the
- <example> tag, not out
- </para>
- <programlisting role="php">
-<![CDATA[
-<?php
-if ($anexample === true) {
- echo 'Use the PEAR Coding Standards';
-}
-?>
-]]>
- </programlisting>
- &example.outputs;
- <screen>
-<![CDATA[
-Use the PEAR Coding Standards
-]]>
- </screen>
- </example>
+ Undefined value.
</para>
</refsect1>
- -->
-
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>newt_pop_window</function></member>
+ <member><function>newt_centered_window</function></member>
</simplelist>
</para>
</refsect1>
- -->
-
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/newt/functions/newt-pop-window.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/newt/functions/newt-pop-window.xml
diff -u phpdoc/en/reference/newt/functions/newt-pop-window.xml:1.2
phpdoc/en/reference/newt/functions/newt-pop-window.xml:1.3
--- phpdoc/en/reference/newt/functions/newt-pop-window.xml:1.2 Mon Oct 10
08:07:56 2005
+++ phpdoc/en/reference/newt/functions/newt-pop-window.xml Mon Oct 10
09:57:42 2005
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.newt-pop-window">
<refnamediv>
<refname>newt_pop_window</refname>
- <refpurpose></refpurpose>
+ <refpurpose>Removes the top window from the display</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@@ -11,102 +11,19 @@
<type>void</type><methodname>newt_pop_window</methodname>
<void/>
</methodsynopsis>
-
- &warn.undocumented.func;
-
- </refsect1>
- <refsect1 role="parameters">
- &reftitle.parameters;
- <para>
- </para>
- </refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
- What the function returns, first on success, then on failure. See
- also the &return.success; entity
- </para>
- </refsect1>
-
- <!-- Use when EXCEPTIONS exist
- <refsect1 role="exceptions">
- &reftitle.exceptions;
- <para>
- When does this function throw exceptions?
- </para>
+ <para>Removes the top window from the display, and redraws the display areas
+ which the window overwrote.</para>
</refsect1>
- -->
-
- <!-- Use when a CHANGELOG exists
- <refsect1 role="changelog">
- &reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Enter the PHP version of change here</entry>
- <entry>Description of change</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- </refsect1>
- -->
-
-
- <!-- Use when examples exist
- <refsect1 role="examples">
- &reftitle.examples;
- <para>
- <example>
- <title>A <function>newt_pop_window</function> example</title>
- <para>
- Any text that describes the purpose of the example, or
- what goes on in the example should go here (inside the
- <example> tag, not out
- </para>
- <programlisting role="php">
-<![CDATA[
-<?php
-if ($anexample === true) {
- echo 'Use the PEAR Coding Standards';
-}
-?>
-]]>
- </programlisting>
- &example.outputs;
- <screen>
-<![CDATA[
-Use the PEAR Coding Standards
-]]>
- </screen>
- </example>
- </para>
- </refsect1>
- -->
-
-
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>newt_open_window</function></member>
+ <member><function>newt_centered_window</function></member>
</simplelist>
</para>
</refsect1>
- -->
-
</refentry>
