cvs: phpdoc /en/reference/ncurses/functions ncurses-addch.xml ncurses-addchnstr.xml ncurses-addchstr.xml ncurses-addnstr.xml ncurses-addstr.xml
ncurses-assume-default-colors.xml ncurses-attroff.xml ncurses-attron.xml ncurses-attrset.xml ncurses-baudrate.xml ncurses-beep.xml ncurses-bkgd.xml
ncurses-bkgdset.xml ncurses-border.xml ncurses-bottom-panel.xml ncurses-can-change-color.xml ncurses-cbreak.xml ncurses-clear.xml ncurses-clrtobot.xml
ncurses-clrtoeol.xml ncurses-color-content.xml ncurses-color-set.xml ncurses-curs-set.xml ncurses-def-prog-mode.xml ncurses-def-shell-mode.xml
ncurses-define-key.xml ncurses-del-panel.xml ncurses-delay-output.xml ncurses-delch.xml ncurses-deleteln.xml ncurses-delwin.xml ncurses-doupdate.xml
ncurses-echo.xml ncurses-echochar.xml ncurses-end.xml ncurses-erase.xml ncurses-erasechar.xml ncurses-filter.xml ncurses-flash.xml
ncurses-flushinp.xml ncurses-getch.xml ncurses-getmaxyx.xml ncurses-getmouse.xml ncurses-getyx.xml ncurses-halfdel! ay.xml ncurses-has-colors.xml
ncurses-has-ic.xml ncurses-has-il.xml ncurses-has-key.xml ncurses-hide-panel.xml ncurses-hline.xml ncurses-inch.xml ncurses-init-color.xml
ncurses-init-pair.xml ncurses-init.xml ncurses-insch.xml ncurses-insdelln.xml ncurses-insertln.xml ncurses-insstr.xml ncurses-instr.xml
ncurses-isendwin.xml ncurses-keyok.xml ncurses-keypad.xml ncurses-killchar.xml ncurses-longname.xml ncurses-meta.xml ncurses-mouse-trafo.xml
ncurses-mouseinterval.xml ncurses-mousemask.xml ncurses-move-panel.xml ncurses-move.xml ncurses-mvaddch.xml ncurses-mvaddchnstr.xml
ncurses-mvaddchstr.xml ncurses-mvaddnstr.xml ncurses-mvaddstr.xml ncurses-mvcur.xml ncurses-mvdelch.xml ncurses-mvgetch.xml ncurses-mvhline.xml
ncurses-mvinch.xml ncurses-mvvline.xml ncurses-mvwaddstr.xml ncurses-napms.xml ncurses-new-panel.xml ncurses-newpad.xml ncurses-newwin.xml
ncurses-nl.xml ncurses-nocbreak.xml ncurses-noecho.xml ncurses-nonl.xml ncurses-noqiflush.xml ncurses-noraw.xml ncurses-pair-co! ntent.xml
ncurses-panel-above.xml ncurses-panel-below.xml ncurses-panel-window.xml ncurses-pnoutrefresh.xml ncurses-prefresh.xml ncurses-putp.xml
ncurses-qiflush.xml ncurses-raw.xml ncurses-refresh.xml ncurses-replace-panel.xml ncurses-reset-prog-mode.xml ncurses-reset-shell-mode.xml
ncurses-resetty.xml ncurses-savetty.xml n

From: Date: Mon, 15 Jan 2007 23:41:56 +0000
Subject: cvs: phpdoc /en/reference/ncurses/functions ncurses-addch.xml ncurses-addchnstr.xml ncurses-addchstr.xml ncurses-addnstr.xml ncurses-addstr.xml
ncurses-assume-default-colors.xml ncurses-attroff.xml ncurses-attron.xml ncurses-attrset.xml ncurses-baudrate.xml ncurses-beep.xml ncurses-bkgd.xml
ncurses-bkgdset.xml ncurses-border.xml ncurses-bottom-panel.xml ncurses-can-change-color.xml ncurses-cbreak.xml ncurses-clear.xml ncurses-clrtobot.xml
ncurses-clrtoeol.xml ncurses-color-content.xml ncurses-color-set.xml ncurses-curs-set.xml ncurses-def-prog-mode.xml ncurses-def-shell-mode.xml
ncurses-define-key.xml ncurses-del-panel.xml ncurses-delay-output.xml ncurses-delch.xml ncurses-deleteln.xml ncurses-delwin.xml ncurses-doupdate.xml
ncurses-echo.xml ncurses-echochar.xml ncurses-end.xml ncurses-erase.xml ncurses-erasechar.xml ncurses-filter.xml ncurses-flash.xml
ncurses-flushinp.xml ncurses-getch.xml ncurses-getmaxyx.xml ncurses-getmouse.xml ncurses-getyx.xml ncurses-halfdel! ay.xml ncurses-has-colors.xml
ncurses-has-ic.xml ncurses-has-il.xml ncurses-has-key.xml ncurses-hide-panel.xml ncurses-hline.xml ncurses-inch.xml ncurses-init-color.xml
ncurses-init-pair.xml ncurses-init.xml ncurses-insch.xml ncurses-insdelln.xml ncurses-insertln.xml ncurses-insstr.xml ncurses-instr.xml
ncurses-isendwin.xml ncurses-keyok.xml ncurses-keypad.xml ncurses-killchar.xml ncurses-longname.xml ncurses-meta.xml ncurses-mouse-trafo.xml
ncurses-mouseinterval.xml ncurses-mousemask.xml ncurses-move-panel.xml ncurses-move.xml ncurses-mvaddch.xml ncurses-mvaddchnstr.xml
ncurses-mvaddchstr.xml ncurses-mvaddnstr.xml ncurses-mvaddstr.xml ncurses-mvcur.xml ncurses-mvdelch.xml ncurses-mvgetch.xml ncurses-mvhline.xml
ncurses-mvinch.xml ncurses-mvvline.xml ncurses-mvwaddstr.xml ncurses-napms.xml ncurses-new-panel.xml ncurses-newpad.xml ncurses-newwin.xml
ncurses-nl.xml ncurses-nocbreak.xml ncurses-noecho.xml ncurses-nonl.xml ncurses-noqiflush.xml ncurses-noraw.xml ncurses-pair-co! ntent.xml
ncurses-panel-above.xml ncurses-panel-below.xml ncurses-panel-window.xml ncurses-pnoutrefresh.xml ncurses-prefresh.xml ncurses-putp.xml
ncurses-qiflush.xml ncurses-raw.xml ncurses-refresh.xml ncurses-replace-panel.xml ncurses-reset-prog-mode.xml ncurses-reset-shell-mode.xml
ncurses-resetty.xml ncurses-savetty.xml n
Groups: php.doc 
Request: Send a blank email to phpdoc+get-969374823@lists.php.net to get a copy of this message
didou Mon Jan 15 23:41:56 2007 UTC Modified files: /phpdoc/en/reference/ncurses/functions ncurses-addch.xml ncurses-addchnstr.xml ncurses-addchstr.xml ncurses-addnstr.xml ncurses-addstr.xml ncurses-assume-default-colors.xml ncurses-attroff.xml ncurses-attron.xml ncurses-attrset.xml ncurses-baudrate.xml ncurses-beep.xml ncurses-bkgd.xml ncurses-bkgdset.xml ncurses-border.xml ncurses-bottom-panel.xml ncurses-can-change-color.xml ncurses-cbreak.xml ncurses-clear.xml ncurses-clrtobot.xml ncurses-clrtoeol.xml ncurses-color-content.xml ncurses-color-set.xml ncurses-curs-set.xml ncurses-def-prog-mode.xml ncurses-def-shell-mode.xml ncurses-define-key.xml ncurses-del-panel.xml ncurses-delay-output.xml ncurses-delch.xml ncurses-deleteln.xml ncurses-delwin.xml ncurses-doupdate.xml ncurses-echo.xml ncurses-echochar.xml ncurses-end.xml ncurses-erase.xml ncurses-erasechar.xml ncurses-filter.xml ncurses-flash.xml ncurses-flushinp.xml ncurses-getch.xml ncurses-getmaxyx.xml ncurses-getmouse.xml ncurses-getyx.xml ncurses-halfdelay.xml ncurses-has-colors.xml ncurses-has-ic.xml ncurses-has-il.xml ncurses-has-key.xml ncurses-hide-panel.xml ncurses-hline.xml ncurses-inch.xml ncurses-init-color.xml ncurses-init-pair.xml ncurses-init.xml ncurses-insch.xml ncurses-insdelln.xml ncurses-insertln.xml ncurses-insstr.xml ncurses-instr.xml ncurses-isendwin.xml ncurses-keyok.xml ncurses-keypad.xml ncurses-killchar.xml ncurses-longname.xml ncurses-meta.xml ncurses-mouse-trafo.xml ncurses-mouseinterval.xml ncurses-mousemask.xml ncurses-move-panel.xml ncurses-move.xml ncurses-mvaddch.xml ncurses-mvaddchnstr.xml ncurses-mvaddchstr.xml ncurses-mvaddnstr.xml ncurses-mvaddstr.xml ncurses-mvcur.xml ncurses-mvdelch.xml ncurses-mvgetch.xml ncurses-mvhline.xml ncurses-mvinch.xml ncurses-mvvline.xml ncurses-mvwaddstr.xml ncurses-napms.xml ncurses-new-panel.xml ncurses-newpad.xml ncurses-newwin.xml ncurses-nl.xml ncurses-nocbreak.xml ncurses-noecho.xml ncurses-nonl.xml ncurses-noqiflush.xml ncurses-noraw.xml ncurses-pair-content.xml ncurses-panel-above.xml ncurses-panel-below.xml ncurses-panel-window.xml ncurses-pnoutrefresh.xml ncurses-prefresh.xml ncurses-putp.xml ncurses-qiflush.xml ncurses-raw.xml ncurses-refresh.xml ncurses-replace-panel.xml ncurses-reset-prog-mode.xml ncurses-reset-shell-mode.xml ncurses-resetty.xml ncurses-savetty.xml ncurses-scr-dump.xml ncurses-scr-init.xml ncurses-scr-restore.xml ncurses-scr-set.xml ncurses-scrl.xml ncurses-show-panel.xml ncurses-slk-attr.xml ncurses-slk-attroff.xml ncurses-slk-attron.xml ncurses-slk-attrset.xml ncurses-slk-clear.xml ncurses-slk-color.xml ncurses-slk-init.xml ncurses-slk-noutrefresh.xml ncurses-slk-refresh.xml ncurses-slk-restore.xml ncurses-slk-set.xml ncurses-slk-touch.xml ncurses-standend.xml ncurses-standout.xml ncurses-start-color.xml ncurses-termattrs.xml ncurses-termname.xml ncurses-timeout.xml ncurses-top-panel.xml ncurses-typeahead.xml ncurses-ungetch.xml ncurses-ungetmouse.xml ncurses-update-panels.xml ncurses-use-default-colors.xml ncurses-use-env.xml ncurses-use-extended-names.xml ncurses-vidattr.xml ncurses-vline.xml ncurses-waddch.xml ncurses-waddstr.xml ncurses-wattroff.xml ncurses-wattron.xml ncurses-wattrset.xml ncurses-wborder.xml ncurses-wclear.xml ncurses-wcolor-set.xml ncurses-werase.xml ncurses-wgetch.xml ncurses-whline.xml ncurses-wmouse-trafo.xml ncurses-wmove.xml ncurses-wnoutrefresh.xml ncurses-wrefresh.xml ncurses-wstandend.xml ncurses-wstandout.xml ncurses-wvline.xml Log: ncurses: switch to new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-addch.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-addch.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-addch.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-addch.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-addch.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-addch.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-addch"> <refnamediv> <refname>ncurses_addch</refname> <refpurpose>Add character at current position and advance cursor </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_addch</methodname> <methodparam><type>int</type><parameter>ch</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>ch</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-addchnstr.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-addchnstr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-addchnstr.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-addchnstr.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-addchnstr.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-addchnstr.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-addchnstr"> <refnamediv> <refname>ncurses_addchnstr</refname> <refpurpose>Add attributed string with specified length at current position </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_addchnstr</methodname> <methodparam><type>string</type><parameter>s</parameter></methodparam> <methodparam><type>int</type><parameter>n</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>s</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>n</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-addchstr.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-addchstr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-addchstr.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-addchstr.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-addchstr.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-addchstr.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-addchstr"> <refnamediv> <refname>ncurses_addchstr</refname> <refpurpose>Add attributed string at current position </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_addchstr</methodname> <methodparam><type>string</type><parameter>s</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>s</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-addnstr.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-addnstr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-addnstr.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-addnstr.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-addnstr.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-addnstr.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-addnstr"> <refnamediv> <refname>ncurses_addnstr</refname> <refpurpose>Add string with specified length at current position </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_addnstr</methodname> <methodparam><type>string</type><parameter>s</parameter></methodparam> <methodparam><type>int</type><parameter>n</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>s</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>n</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-addstr.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-addstr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-addstr.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-addstr.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-addstr.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-addstr.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-addstr"> <refnamediv> <refname>ncurses_addstr</refname> <refpurpose>Output text at current position </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_addstr</methodname> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-assume-default-colors.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-assume-default-colors.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-assume-default-colors.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-assume-default-colors.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-assume-default-colors.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-assume-default-colors.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-assume-default-colors"> <refnamediv> <refname>ncurses_assume_default_colors</refname> <refpurpose>Define default colors for color 0 </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_assume_default_colors</methodname> <methodparam><type>int</type><parameter>fg</parameter></methodparam> <methodparam><type>int</type><parameter>bg</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>fg</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>bg</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-attroff.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-attroff.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-attroff.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-attroff.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-attroff.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-attroff.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-attroff"> <refnamediv> <refname>ncurses_attroff</refname> <refpurpose>Turn off the given attributes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_attroff</methodname> <methodparam><type>int</type><parameter>attributes</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>attributes</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-attron.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-attron.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-attron.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-attron.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-attron.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-attron.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-attron"> <refnamediv> <refname>ncurses_attron</refname> <refpurpose>Turn on the given attributes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_attron</methodname> <methodparam><type>int</type><parameter>attributes</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>attributes</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-attrset.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-attrset.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-attrset.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-attrset.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-attrset.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-attrset.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-attrset"> <refnamediv> <refname>ncurses_attrset</refname> <refpurpose>Set given attributes</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_attrset</methodname> <methodparam><type>int</type><parameter>attributes</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>attributes</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-baudrate.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-baudrate.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-baudrate.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-baudrate.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-baudrate.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-baudrate.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-baudrate"> <refnamediv> <refname>ncurses_baudrate</refname> <refpurpose>Returns baudrate of terminal </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_baudrate</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-beep.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-beep.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-beep.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-beep.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-beep.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-beep.xml Mon Jan 15 23:41:54 2007 @@ -1,25 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-beep"> <refnamediv> <refname>ncurses_beep</refname> <refpurpose>Let the terminal beep </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_beep</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> <function>ncurses_beep</function> sends an audible alert (bell) and if its not possible flashes the screen. - &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>ncurses_flash</function> + <simplelist> + <member><function>ncurses_flash</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-bkgd.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-bkgd.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-bkgd.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-bkgd.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-bkgd.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-bkgd.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-bkgd"> <refnamediv> <refname>ncurses_bkgd</refname> <refpurpose>Set background property for terminal screen </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_bkgd</methodname> <methodparam><type>int</type><parameter>attrchar</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>attrchar</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-bkgdset.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-bkgdset.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-bkgdset.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-bkgdset.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-bkgdset.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-bkgdset.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-bkgdset"> <refnamediv> <refname>ncurses_bkgdset</refname> <refpurpose>Control screen background </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>ncurses_bkgdset</methodname> <methodparam><type>int</type><parameter>attrchar</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>attrchar</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-border.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-border.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-border.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-border.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-border.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-border.xml Mon Jan 15 23:41:54 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-border"> <refnamediv> <refname>ncurses_border</refname> <refpurpose>Draw a border around the screen using attributed characters</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_border</methodname> <methodparam><type>int</type><parameter>left</parameter></methodparam> @@ -20,18 +19,88 @@ <methodparam><type>int</type><parameter>br_corner</parameter></methodparam> </methodsynopsis> &warn.experimental.func; - <simpara> - <function>ncurses_border</function> draws the specified lines and - corners around the main window. Each parameter expects 0 to draw - a line and 1 to skip it. The corners are top left, top right, - bottom left and bottom right. - </simpara> - <simpara> + <para> + Draws the specified lines and corners around the main window. + </para> + <para> Use <function>ncurses_wborder</function> for borders around subwindows! - </simpara> - <simpara> - See also <function>ncurses_wborder</function>. - </simpara> + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + Every parameter expects 0 to draw a line or 1 to skip it. + <variablelist> + <varlistentry> + <term><parameter>left</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>top</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>bottom</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tl_corner</parameter></term> + <listitem> + <para> + Top left corner + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tr_corner</parameter></term> + <listitem> + <para> + Top right corner + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>bl_corner</parameter></term> + <listitem> + <para> + Bottom left corner + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>br_corner</parameter></term> + <listitem> + <para> + Bottom right corner + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ncurses_wborder</function></member> + </simplelist> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-bottom-panel.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-bottom-panel.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-bottom-panel.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-bottom-panel.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-bottom-panel.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-bottom-panel.xml Mon Jan 15 23:41:54 2007 @@ -1,19 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-bottom-panel"> <refnamediv> <refname>ncurses_bottom_panel</refname> <refpurpose>Moves a visible panel to the bottom of the stack</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_bottom_panel</methodname> <methodparam><type>resource</type><parameter>panel</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>panel</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-can-change-color.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-can-change-color.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-can-change-color.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-can-change-color.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-can-change-color.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-can-change-color.xml Mon Jan 15 23:41:54 2007 @@ -1,22 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-can-change-color"> <refnamediv> <refname>ncurses_can_change_color</refname> <refpurpose>Check if we can change terminals colors </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_can_change_color</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - The function <function>ncurses_can_change_color</function> returns - &true; or &false;, depending on whether the terminal has color - capabilities and whether the programmer can change the colors. + Tells whether the terminal has color capabilities and whether the + programmer can change the colors. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Return &true; if the terminal has color capabilities and you can change + the colors, &false; otherwise. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-cbreak.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-cbreak.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-cbreak.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-cbreak.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-cbreak.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-cbreak.xml Mon Jan 15 23:41:54 2007 @@ -1,30 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-cbreak"> <refnamediv> <refname>ncurses_cbreak</refname> <refpurpose>Switch of input buffering </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_cbreak</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_cbreak</function> disables line buffering and - character processing (interrupt and flow control characters are - unaffected), making characters typed by the user immediately - available to the program. + Disables line buffering and character processing (interrupt and flow + control characters are unaffected), making characters typed by the user + immediately available to the program. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>ncurses_cbreak</function> returns &true; or NCURSES_ERR - if any error occurred. + Returns &true; or NCURSES_ERR if any error occurred. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_nocbreak</function> + <simplelist> + <member><function>ncurses_nocbreak</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-clear.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-clear.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-clear.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-clear.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-clear.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-clear.xml Mon Jan 15 23:41:54 2007 @@ -1,29 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-clear"> <refnamediv> <refname>ncurses_clear</refname> <refpurpose>Clear screen </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_clear</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_clear</function> clears the screen completely - without setting blanks. &return.success; + Clears the screen completely without setting blanks. </para> <para> - Note: <function>ncurses_clear</function> clears the screen without - setting blanks, which have the current background rendition. To - clear screen with blanks, use <function>ncurses_erase</function>. + Note: <function>ncurses_clear</function> clears the screen without + setting blanks, which have the current background rendition. To + clear screen with blanks, use <function>ncurses_erase</function>. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>ncurses_erase</function>. + <simplelist> + <member><function>ncurses_erase</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-clrtobot.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-clrtobot.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-clrtobot.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-clrtobot.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-clrtobot.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-clrtobot.xml Mon Jan 15 23:41:54 2007 @@ -1,28 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-clrtobot"> <refnamediv> <refname>ncurses_clrtobot</refname> <refpurpose>Clear screen from current position to bottom </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_clrtobot</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_clrtobot</function> erases all lines from cursor - to end of screen and creates blanks. Blanks created by - <function>ncurses_clrtobot</function> have the current background - rendition. &return.success; + Erases all lines from cursor to end of screen and creates blanks. Blanks + created by <function>ncurses_clrtobot</function> have the current + background rendition. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>ncurses_clear</function>, and - <function>ncurses_clrtoeol</function> + <simplelist> + <member><function>ncurses_clear</function></member> + <member><function>ncurses_clrtoeol</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-clrtoeol.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-clrtoeol.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-clrtoeol.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-clrtoeol.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-clrtoeol.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-clrtoeol.xml Mon Jan 15 23:41:54 2007 @@ -1,27 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-clrtoeol"> <refnamediv> <refname>ncurses_clrtoeol</refname> <refpurpose>Clear screen from current position to end of line </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_clrtoeol</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> - <function>ncurses_clrtoeol</function> erases the current line from - cursor position to the end. Blanks created by - <function>ncurses_clrtoeol</function> have the current background - rendition. &return.success; + Erases the current line from cursor position to the end. Blanks created by + <function>ncurses_clrtoeol</function> have the current background + rendition. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>ncurses_clear</function>, and - <function>ncurses_clrtobot</function> + <simplelist> + <member><function>ncurses_clear</function></member> + <member><function>ncurses_clrtobot</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-color-content.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-color-content.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-color-content.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-color-content.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-color-content.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-color-content.xml Mon Jan 15 23:41:54 2007 @@ -1,13 +1,12 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-color-content"> <refnamediv> <refname>ncurses_color_content</refname> <refpurpose>Gets the RGB value for color</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_color_content</methodname> <methodparam><type>int</type><parameter>color</parameter></methodparam> @@ -15,8 +14,41 @@ <methodparam><type>int</type><parameter role="reference">g</parameter></methodparam> <methodparam><type>int</type><parameter role="reference">b</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>r</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>g</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>b</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-color-set.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-color-set.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-color-set.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-color-set.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-color-set.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-color-set.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-color-set"> <refnamediv> <refname>ncurses_color_set</refname> <refpurpose>Set fore- and background color </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_color_set</methodname> <methodparam><type>int</type><parameter>pair</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>pair</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-curs-set.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-curs-set.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-curs-set.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-curs-set.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-curs-set.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-curs-set.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-curs-set"> <refnamediv> <refname>ncurses_curs_set</refname> <refpurpose>Set cursor state </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_curs_set</methodname> <methodparam><type>int</type><parameter>visibility</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>visibility</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-def-prog-mode.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-def-prog-mode.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-def-prog-mode.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-def-prog-mode.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-def-prog-mode.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-def-prog-mode.xml Mon Jan 15 23:41:54 2007 @@ -1,26 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-def-prog-mode"> <refnamediv> <refname>ncurses_def_prog_mode</refname> <refpurpose>Saves terminals (program) mode</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_def_prog_mode</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_def_prog_mode</function> saves the current - terminal modes for program (in curses) for use by - <function>ncurses_reset_prog_mode</function>. Returns &false; on - success, otherwise &true;. + Saves the current terminal modes for program (in curses) for use by + <function>ncurses_reset_prog_mode</function>. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &false; on success, otherwise &true;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_reset_prog_mode</function> + <simplelist> + <member><function>ncurses_reset_prog_mode</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-def-shell-mode.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-def-shell-mode.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-def-shell-mode.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-def-shell-mode.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-def-shell-mode.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-def-shell-mode.xml Mon Jan 15 23:41:54 2007 @@ -1,26 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-def-shell-mode"> <refnamediv> <refname>ncurses_def_shell_mode</refname> <refpurpose>Saves terminals (shell) mode</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_def_shell_mode</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_def_shell_mode</function> saves the current - terminal modes for shell (not in curses) for use by - <function>ncurses_reset_shell_mode</function>. Returns &false; on - success, otherwise &true;. + Saves the current terminal modes for shell (not in curses) for use by + <function>ncurses_reset_shell_mode</function>. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &false; on success, &true; otherwise. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_reset_shell_mode</function> + <simplelist> + <member><function>ncurses_reset_shell_mode</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-define-key.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-define-key.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-define-key.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-define-key.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-define-key.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-define-key.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-define-key"> <refnamediv> <refname>ncurses_define_key</refname> <refpurpose>Define a keycode </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_define_key</methodname> <methodparam><type>string</type><parameter>definition</parameter></methodparam> <methodparam><type>int</type><parameter>keycode</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>definition</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>keycode</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-del-panel.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-del-panel.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-del-panel.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-del-panel.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-del-panel.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-del-panel.xml Mon Jan 15 23:41:54 2007 @@ -1,19 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-del-panel"> <refnamediv> <refname>ncurses_del_panel</refname> <refpurpose>Remove panel from the stack and delete it (but not the associated window)</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_del_panel</methodname> <methodparam><type>resource</type><parameter>panel</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>panel</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-delay-output.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-delay-output.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-delay-output.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-delay-output.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-delay-output.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-delay-output.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-delay-output"> <refnamediv> <refname>ncurses_delay_output</refname> <refpurpose>Delay output on terminal using padding characters </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_delay_output</methodname> <methodparam><type>int</type><parameter>milliseconds</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>milliseconds</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-delch.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-delch.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-delch.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-delch.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-delch.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-delch.xml Mon Jan 15 23:41:54 2007 @@ -1,27 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-delch"> <refnamediv> <refname>ncurses_delch</refname> <refpurpose>Delete character at current position, move rest of line left </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_delch</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_delch</function> deletes the character under - the cursor. All characters to the right of the cursor on the same - line are moved to the left one position and the last character on - the line is filled with a blank. The cursor position does - not change. Returns &false; on success, otherwise &true;. + Deletes the character under the cursor. All characters to the right of the + cursor on the same line are moved to the left one position and the last + character on the line is filled with a blank. The cursor position does not + change. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &false; on success, &true; otherwise. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_deleteln</function> + <simplelist> + <member><function>ncurses_deleteln</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-deleteln.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-deleteln.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-deleteln.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-deleteln.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-deleteln.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-deleteln.xml Mon Jan 15 23:41:54 2007 @@ -1,28 +1,35 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-deleteln"> <refnamediv> <refname>ncurses_deleteln</refname> <refpurpose>Delete line at current position, move rest of screen up </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_deleteln</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> - <function>ncurses_deleteln</function> deletes the current line under - cursorposition. All lines below the current line are moved up one - line. - The bottom line of window is cleared. Cursor position does not - change. - Returns &false; on success, otherwise &true;. + Deletes the current line under cursorposition. All lines below the current + line are moved up one line. The bottom line of window is cleared. Cursor + position does not change. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &false; on success, otherwise &true;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_delch</function> + <simplelist> + <member><function>ncurses_delch</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-delwin.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-delwin.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-delwin.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-delwin.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-delwin.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-delwin.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-delwin"> <refnamediv> <refname>ncurses_delwin</refname> <refpurpose>Delete a ncurses window </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_delwin</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-doupdate.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-doupdate.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-doupdate.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-doupdate.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-doupdate.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-doupdate.xml Mon Jan 15 23:41:54 2007 @@ -1,23 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-doupdate"> <refnamediv> <refname>ncurses_doupdate</refname> <refpurpose>Write all prepared refreshes to terminal </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_doupdate</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_doupdate</function> compares the virtual screen to the - physical screen and updates the physical screen. This way is more - effective than using multiple refresh calls. - &return.success; + Compares the virtual screen to the physical screen and updates the + physical screen. This way is more effective than using multiple refresh + calls. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-echo.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-echo.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-echo.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-echo.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-echo.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-echo.xml Mon Jan 15 23:41:54 2007 @@ -1,26 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-echo"> <refnamediv> <refname>ncurses_echo</refname> <refpurpose>Activate keyboard input echo </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_echo</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_echo</function> enables echo mode. - All characters typed by user are echoed by - <function>ncurses_getch</function>. - Returns &false; on success, &true; if any error occurred. + Enables echo mode. All characters typed by user are echoed by + <function>ncurses_getch</function>. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &false; on success, &true; if any error occurred. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - To disable echo mode use <function>ncurses_noecho</function>. + <simplelist> + <member><function>ncurses_noecho</function> to disable echo mode</member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-echochar.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-echochar.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-echochar.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-echochar.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-echochar.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-echochar.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-echochar"> <refnamediv> <refname>ncurses_echochar</refname> <refpurpose>Single character output including refresh </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_echochar</methodname> <methodparam><type>int</type><parameter>character</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>character</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-end.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-end.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-end.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-end.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-end.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-end.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-end"> <refnamediv> <refname>ncurses_end</refname> <refpurpose>Stop using ncurses, clean up the screen </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_end</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-erase.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-erase.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-erase.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-erase.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-erase.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-erase.xml Mon Jan 15 23:41:54 2007 @@ -1,27 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-erase"> <refnamediv> <refname>ncurses_erase</refname> <refpurpose>Erase terminal screen </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_erase</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + <para> + Fills the terminal screen with blanks. + </para> + <para> + Created blanks have the current background rendition, set by + <function>ncurses_bkgd</function>. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>ncurses_erase</function> fills the terminal screen with - blanks. Created blanks have the current background rendition, set - by <function>ncurses_bkgd</function>. &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>ncurses_bkgd</function>, and - <function>ncurses_clear</function> + <simplelist> + <member><function>ncurses_bkgd</function></member> + <member><function>ncurses_clear</function></member> + </simplelist> </para> </refsect1> </refentry> @@ -29,7 +40,7 @@ <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t +<sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-erasechar.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-erasechar.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-erasechar.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-erasechar.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-erasechar.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-erasechar.xml Mon Jan 15 23:41:54 2007 @@ -1,24 +1,33 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-erasechar"> <refnamediv> <refname>ncurses_erasechar</refname> <refpurpose>Returns current erase character </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ncurses_erasechar</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_erasechar</function> returns the current erase - char character. + Returns the current erase character. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The current erase char, as a string. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_killchar</function> + <simplelist> + <member><function>ncurses_killchar</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-filter.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-filter.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-filter.xml:1.6 phpdoc/en/reference/ncurses/functions/ncurses-filter.xml:1.7 --- phpdoc/en/reference/ncurses/functions/ncurses-filter.xml:1.6 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-filter.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.ncurses-filter"> <refnamediv> <refname>ncurses_filter</refname> <refpurpose>Set LINES for iniscr() and newterm() to 1</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>ncurses_filter</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-flash.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-flash.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-flash.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-flash.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-flash.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-flash.xml Mon Jan 15 23:41:54 2007 @@ -1,25 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-flash"> <refnamediv> <refname>ncurses_flash</refname> <refpurpose>Flash terminal screen (visual bell) </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_flash</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + <para> + Flashes the screen, and if its not possible, sends an audible alert + (bell). + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>ncurses_flash</function> flashes the screen, and if - its not possible, sends an audible alert (bell). Returns &false; on success, otherwise &true;. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_beep</function> + <simplelist> + <member><function>ncurses_beep</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-flushinp.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-flushinp.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-flushinp.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-flushinp.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-flushinp.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-flushinp.xml Mon Jan 15 23:41:54 2007 @@ -1,22 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-flushinp"> <refnamediv> <refname>ncurses_flushinp</refname> <refpurpose>Flush keyboard input buffer </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_flushinp</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> - The <function>ncurses_flushinp</function> throws away any - typeahead that has been typed and has not yet been read by your - program. + Throws away any typeahead that has been typed and has not yet been read by + your program. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns &false; on success, otherwise &true;. </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-getch.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-getch.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-getch.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-getch.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-getch.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-getch.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-getch"> <refnamediv> <refname>ncurses_getch</refname> <refpurpose>Read a character from keyboard </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_getch</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-getmaxyx.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-getmaxyx.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-getmaxyx.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-getmaxyx.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-getmaxyx.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-getmaxyx.xml Mon Jan 15 23:41:54 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-getmaxyx"> <refnamediv> <refname>ncurses_getmaxyx</refname> <refpurpose>Returns the size of a window</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>ncurses_getmaxyx</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> @@ -14,14 +14,51 @@ <methodparam><type>int</type><parameter role="reference">x</parameter></methodparam> </methodsynopsis> &warn.experimental.func; - <simpara> - <function>ncurses_getmaxyx</function> puts the horizontal and - vertical size of the window <parameter>window</parameter> - into the given variables <parameter>y</parameter> and - <parameter>x</parameter>. Variables must be passed - as reference, so they are updated when the user changes terminal - size. - </simpara> + <para> + Gets the horizontal and vertical size of the given + <parameter>window</parameter> into the given variables. + </para> + <para> + Variables must be passed as reference, so they are updated when the user + changes the terminal size. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + The measured window + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + This will be set to the window width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + This will be set to the window height + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-getmouse.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-getmouse.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-getmouse.xml:1.7 phpdoc/en/reference/ncurses/functions/ncurses-getmouse.xml:1.8 --- phpdoc/en/reference/ncurses/functions/ncurses-getmouse.xml:1.7 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-getmouse.xml Mon Jan 15 23:41:54 2007 @@ -1,43 +1,81 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.5 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.ncurses-getmouse"> - <refnamediv> - <refname>ncurses_getmouse</refname> - <refpurpose>Reads mouse event</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ncurses_getmouse</methodname> - <methodparam><type>array</type><parameter role="reference">mevent</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - <function>ncurses_getmouse</function> reads mouse event out of - queue. Function <function>ncurses_getmouse</function> will return - ;&false; if a mouse event is actually visible in the given - window, otherwise it will return &true;. - Event options will be delivered in parameter - <parameter>mevent</parameter>, which has to be an array, passed - by reference (see example below). - On success an associative array with following keys will be - delivered: - <itemizedlist> - <listitem><para>"id" : Id to distinguish multiple - devices</para></listitem> - <listitem><para>"x" : screen relative x-position in character - cells</para></listitem> - <listitem><para>"y" : screen relative y-position in character - cells</para></listitem> - <listitem><para>"z" : currently not supported</para></listitem> - <listitem><para>"mmask" : Mouse action</para></listitem> - </itemizedlist> - </para> - <para> - <example> - <title><function>ncurses_getmouse</function> example</title> - <programlisting role="php"> + <refnamediv> + <refname>ncurses_getmouse</refname> + <refpurpose>Reads mouse event</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>ncurses_getmouse</methodname> + <methodparam><type>array</type><parameter role="reference">mevent</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + <function>ncurses_getmouse</function> reads mouse event out of + queue. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>mevent</parameter></term> + <listitem> + <para> + Event options will be delivered in this parameter which has to be an + array, passed by reference (see example below). + </para> + <para> + On success an associative array with following keys will be delivered: + <itemizedlist> + <listitem> + <para> + "id" : Id to distinguish multiple devices + </para> + </listitem> + <listitem> + <para> + "x" : screen relative x-position in character cells + </para> + </listitem> + <listitem> + <para> + "y" : screen relative y-position in character cells + </para> + </listitem> + <listitem> + <para> + "z" : currently not supported + </para> + </listitem> + <listitem> + <para> + "mmask" : Mouse action + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &false; if a mouse event is actually visible in the given window, + otherwise returns &true;. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>ncurses_getmouse</function> example</title> + <programlisting role="php"> <![CDATA[ <?php switch (ncurses_getch()){ @@ -55,14 +93,19 @@ } ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>ncurses_ungetmouse</function> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ncurses_ungetmouse</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-getyx.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-getyx.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-getyx.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-getyx.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-getyx.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-getyx.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,47 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.ncurses-getyx"> <refnamediv> <refname>ncurses_getyx</refname> <refpurpose>Returns the current cursor position for a window</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>ncurses_getyx</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> <methodparam><type>int</type><parameter role="reference">y</parameter></methodparam> <methodparam><type>int</type><parameter role="reference">x</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-halfdelay.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-halfdelay.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-halfdelay.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-halfdelay.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-halfdelay.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-halfdelay.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-halfdelay"> <refnamediv> <refname>ncurses_halfdelay</refname> <refpurpose>Put terminal into halfdelay mode </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_halfdelay</methodname> <methodparam><type>int</type><parameter>tenth</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>tenth</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-has-colors.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-has-colors.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-has-colors.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-has-colors.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-has-colors.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-has-colors.xml Mon Jan 15 23:41:54 2007 @@ -1,24 +1,33 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-has-colors"> <refnamediv> <refname>ncurses_has_colors</refname> <refpurpose>Check if terminal has colors </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_has_colors</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> - <function>ncurses_has_colors</function> returns &true; or &false; - depending on whether the terminal has color capacities. + Checks wether the terminal has color capacities. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Return &true; if the terminal has color capacities, &false; otherwise. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_can_change_color</function> + <simplelist> + <member><function>ncurses_can_change_color</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-has-ic.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-has-ic.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-has-ic.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-has-ic.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-has-ic.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-has-ic.xml Mon Jan 15 23:41:54 2007 @@ -1,25 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-has-ic"> <refnamediv> <refname>ncurses_has_ic</refname> <refpurpose>Check for insert- and delete-capabilities </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_has_ic</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> - <function>ncurses_has_ic</function> checks terminals insert- and - delete capabilities. It returns &true; when terminal has - insert/delete-capabilities, otherwise &false;. + Checks whether the terminal has insert and delete capabilities. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the terminal has insert/delete-capabilities, &false; + otherwise. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_has_il</function> + <simplelist> + <member><function>ncurses_has_il</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-has-il.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-has-il.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-has-il.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-has-il.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-has-il.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-has-il.xml Mon Jan 15 23:41:54 2007 @@ -1,25 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-has-il"> <refnamediv> <refname>ncurses_has_il</refname> <refpurpose>Check for line insert- and delete-capabilities </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_has_il</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_has_il</function> checks terminals insert- and - delete-line-capabilities. It returns &true; when terminal has - insert/delete-line capabilities, otherwise &false; + Checks whether the terminal has insert- and delete-line-capabilities. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if the terminal has insert/delete-line capabilities, + &false; otherwise. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_has_ic</function> + <simplelist> + <member><function>ncurses_has_ic</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-has-key.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-has-key.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-has-key.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-has-key.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-has-key.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-has-key.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-has-key"> <refnamediv> <refname>ncurses_has_key</refname> <refpurpose>Check for presence of a function key on terminal keyboard </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_has_key</methodname> <methodparam><type>int</type><parameter>keycode</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>keycode</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-hide-panel.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-hide-panel.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-hide-panel.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-hide-panel.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-hide-panel.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-hide-panel.xml Mon Jan 15 23:41:54 2007 @@ -1,19 +1,31 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.ncurses-hide-panel"> <refnamediv> <refname>ncurses_hide_panel</refname> <refpurpose>Remove panel from the stack, making it invisible</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_hide_panel</methodname> <methodparam><type>resource</type><parameter>panel</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>panel</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-hline.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-hline.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-hline.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-hline.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-hline.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-hline.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-hline"> <refnamediv> <refname>ncurses_hline</refname> <refpurpose>Draw a horizontal line at current position using an attributed character and max. n characters long </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_hline</methodname> <methodparam><type>int</type><parameter>charattr</parameter></methodparam> <methodparam><type>int</type><parameter>n</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>charattr</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>n</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-inch.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-inch.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-inch.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-inch.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-inch.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-inch.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-inch"> <refnamediv> <refname>ncurses_inch</refname> <refpurpose>Get character and attribute at current position </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ncurses_inch</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> - <function>ncurses_inch</function> returns the character from the - current position. + Returns the character from the current position. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the character, as a string. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-init-color.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-init-color.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-init-color.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-init-color.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-init-color.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-init-color.xml Mon Jan 15 23:41:54 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-init-color"> <refnamediv> <refname>ncurses_init_color</refname> <refpurpose>Set new RGB value for color </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_init_color</methodname> <methodparam><type>int</type><parameter>color</parameter></methodparam> @@ -15,9 +14,42 @@ <methodparam><type>int</type><parameter>g</parameter></methodparam> <methodparam><type>int</type><parameter>b</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>color</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>r</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>g</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>b</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-init-pair.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-init-pair.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-init-pair.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-init-pair.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-init-pair.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-init-pair.xml Mon Jan 15 23:41:54 2007 @@ -1,22 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-init-pair"> <refnamediv> <refname>ncurses_init_pair</refname> <refpurpose>Allocate a color pair </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_init_pair</methodname> <methodparam><type>int</type><parameter>pair</parameter></methodparam> <methodparam><type>int</type><parameter>fg</parameter></methodparam> <methodparam><type>int</type><parameter>bg</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>pair</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fg</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>bg</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-init.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-init.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-init.xml:1.6 phpdoc/en/reference/ncurses/functions/ncurses-init.xml:1.7 --- phpdoc/en/reference/ncurses/functions/ncurses-init.xml:1.6 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-init.xml Mon Jan 15 23:41:54 2007 @@ -1,22 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.ncurses-init"> <refnamediv> <refname>ncurses_init</refname> <refpurpose>Initialize ncurses</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>ncurses_init</methodname> <void/> </methodsynopsis> &warn.experimental.func; - <simpara> - <function>ncurses_init</function> initializes the ncurses - interface and must be used before any other ncurses function. - </simpara> + <para> + Initializes the ncurses interface and must be used before any other + ncurses function call. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-insch.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-insch.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-insch.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-insch.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-insch.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-insch.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-insch"> <refnamediv> <refname>ncurses_insch</refname> <refpurpose>Insert character moving rest of line including character at current position </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_insch</methodname> <methodparam><type>int</type><parameter>character</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>character</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-insdelln.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-insdelln.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-insdelln.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-insdelln.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-insdelln.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-insdelln.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-insdelln"> <refnamediv> <refname>ncurses_insdelln</refname> <refpurpose>Insert lines before current line scrolling down (negative numbers delete and scroll up) </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_insdelln</methodname> <methodparam><type>int</type><parameter>count</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>count</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-insertln.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-insertln.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-insertln.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-insertln.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-insertln.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-insertln.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-insertln"> <refnamediv> <refname>ncurses_insertln</refname> <refpurpose>Insert a line, move rest of screen down </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>bool</type><methodname>ncurses_insertln</methodname> + <type>int</type><methodname>ncurses_insertln</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> - <function>ncurses_insertln</function> inserts a new line above - the current line. The bottom line will be lost. + Inserts a new line above the current line. The bottom line will be lost. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-insstr.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-insstr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-insstr.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-insstr.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-insstr.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-insstr.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-insstr"> <refnamediv> <refname>ncurses_insstr</refname> <refpurpose>Insert string at current position, moving rest of line right </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_insstr</methodname> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-instr.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-instr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-instr.xml:1.7 phpdoc/en/reference/ncurses/functions/ncurses-instr.xml:1.8 --- phpdoc/en/reference/ncurses/functions/ncurses-instr.xml:1.7 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-instr.xml Mon Jan 15 23:41:54 2007 @@ -1,24 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.ncurses-instr"> <refnamediv> <refname>ncurses_instr</refname> - <refpurpose>Reads string from terminal screen </refpurpose> + <refpurpose>Reads string from terminal screen</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_instr</methodname> <methodparam><type>string</type><parameter role="reference">buffer</parameter></methodparam> </methodsynopsis> &warn.experimental.func; <para> - <function>ncurses_instr</function> returns the number of - characters read from the current character position until end of - line. - <parameter>buffer</parameter> contains the characters. Attributes - are stripped from the characters. + Reads a string from the terminal screen and returns the number of + characters read from the current character position until end of line. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>buffer</parameter></term> + <listitem> + <para> + The characters. Attributes will be stripped. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of characters. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-isendwin.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-isendwin.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-isendwin.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-isendwin.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-isendwin.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-isendwin.xml Mon Jan 15 23:41:54 2007 @@ -1,28 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-isendwin"> <refnamediv> <refname>ncurses_isendwin</refname> - <refpurpose>Ncurses is in endwin mode, normal screen output may be performed </refpurpose> + <refpurpose>Ncurses is in endwin mode, normal screen output may be performed</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_isendwin</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> - <function>ncurses_isendwin</function> returns &true;, if - <function>ncurses_endwin</function> has been called without any - subsequent calls to <function>ncurses_wrefresh</function>, - otherwise &false;. + Checks if ncurses is in endwin mode. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true;, if <function>ncurses_endwin</function> has been called + without any subsequent calls to <function>ncurses_wrefresh</function>, + &false; otherwise. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>ncurses_endwin</function> and - <function>ncurses_wrefresh</function>. + <simplelist> + <member><function>ncurses_endwin</function></member> + <member><function>ncurses_wrefresh</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-keyok.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-keyok.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-keyok.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-keyok.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-keyok.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-keyok.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-keyok"> <refnamediv> <refname>ncurses_keyok</refname> <refpurpose>Enable or disable a keycode </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_keyok</methodname> <methodparam><type>int</type><parameter>keycode</parameter></methodparam> <methodparam><type>bool</type><parameter>enable</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>keycode</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>enable</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-keypad.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-keypad.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-keypad.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-keypad.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-keypad.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-keypad.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,38 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-keypad"> <refnamediv> <refname>ncurses_keypad</refname> <refpurpose>Turns keypad on or off</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_keypad</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> <methodparam><type>bool</type><parameter>bf</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>bf</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-killchar.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-killchar.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-killchar.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-killchar.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-killchar.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-killchar.xml Mon Jan 15 23:41:54 2007 @@ -1,24 +1,33 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-killchar"> <refnamediv> <refname>ncurses_killchar</refname> <refpurpose>Returns current line kill character </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>ncurses_killchar</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_killchar</function> returns the current line - kill character. + Returns the current line kill character. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the kill character, as a string. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_erasechar</function> + <simplelist> + <member><function>ncurses_erasechar</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-longname.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-longname.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-longname.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-longname.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-longname.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-longname.xml Mon Jan 15 23:41:54 2007 @@ -1,29 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-longname"> - <refnamediv> - <refname>ncurses_longname</refname> - <refpurpose>Returns terminals description</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ncurses_longname</methodname> - <void/> - </methodsynopsis> - &warn.experimental.func; - <para> - <function>ncurses_longname</function> returns a verbose - description of the terminal. The description is truncated to 128 - characters. - On Error <function>ncurses_longname</function> returns NULL. - </para> - <para> - See also: <function>ncurses_termname</function> - </para> - </refsect1> - </refentry> + <refnamediv> + <refname>ncurses_longname</refname> + <refpurpose>Returns terminals description</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>ncurses_longname</methodname> + <void/> + </methodsynopsis> + &warn.experimental.func; + <para> + Returns a verbose description of the terminal. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the description, as a string truncated to 128 characters. + On errors, returns &null;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ncurses_termname</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-meta.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-meta.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-meta.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-meta.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-meta.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-meta.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,38 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-meta"> <refnamediv> <refname>ncurses_meta</refname> <refpurpose>Enables/Disable 8-bit meta key information</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_meta</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> <methodparam><type>bool</type><parameter>8bit</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>8bit</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mouse-trafo.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mouse-trafo.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mouse-trafo.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-mouse-trafo.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-mouse-trafo.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mouse-trafo.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,46 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-mouse-trafo"> <refnamediv> <refname>ncurses_mouse_trafo</refname> <refpurpose>Transforms coordinates</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_mouse_trafo</methodname> <methodparam><type>int</type><parameter role="reference">y</parameter></methodparam> <methodparam><type>int</type><parameter role="reference">x</parameter></methodparam> <methodparam><type>bool</type><parameter>toscreen</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>toscreen</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mouseinterval.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mouseinterval.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mouseinterval.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-mouseinterval.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-mouseinterval.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mouseinterval.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-mouseinterval"> <refnamediv> <refname>ncurses_mouseinterval</refname> <refpurpose>Set timeout for mouse button clicks </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_mouseinterval</methodname> <methodparam><type>int</type><parameter>milliseconds</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>milliseconds</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mousemask.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mousemask.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mousemask.xml:1.8 phpdoc/en/reference/ncurses/functions/ncurses-mousemask.xml:1.9 --- phpdoc/en/reference/ncurses/functions/ncurses-mousemask.xml:1.8 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mousemask.xml Mon Jan 15 23:41:54 2007 @@ -1,94 +1,121 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.5 --> +<!-- $Revision: 1.9 $ --> <refentry id="function.ncurses-mousemask"> - <refnamediv> - <refname>ncurses_mousemask</refname> - <refpurpose>Sets mouse options</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>ncurses_mousemask</methodname> - <methodparam><type>int</type><parameter>newmask</parameter></methodparam> - <methodparam><type>int</type><parameter role="reference">oldmask</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - Function <function>ncurses_mousemask</function> will set mouse events - to be reported. By default no mouse events will be reported. The - function <function>ncurses_mousemask</function> will return a - mask to indicated which of the in parameter - <parameter>newmask</parameter> - specified mouse events can be reported. On complete failure, it - returns 0. In parameter <parameter>oldmask</parameter>, which is - passed by reference <function>ncurses_mousemask</function> - returns the previous value of mouse event mask. - - Mouse events are represented by NCURSES_KEY_MOUSE in the - <function>ncurses_wgetch</function> input stream. To read the - event data and pop the event of queue, call - <function>ncurses_getmouse</function>. - </para> - <para> - As a side effect, setting a zero mousemask in - <parameter>newmask</parameter> turns off the mouse - pointer. Setting a non zero value turns mouse pointer on. - </para> - <para> - mouse mask options can be set with the following predefined - constants: - <itemizedlist> - <listitem><para>NCURSES_BUTTON1_PRESSED</para></listitem> - <listitem><para>NCURSES_BUTTON1_RELEASED</para></listitem> - <listitem><para>NCURSES_BUTTON1_CLICKED</para></listitem> - <listitem><para>NCURSES_BUTTON1_DOUBLE_CLICKED</para></listitem> - <listitem><para>NCURSES_BUTTON1_TRIPLE_CLICKED</para></listitem> - <listitem><para>NCURSES_BUTTON2_PRESSED</para></listitem> - <listitem><para>NCURSES_BUTTON2_RELEASED</para></listitem> - <listitem><para>NCURSES_BUTTON2_CLICKED</para></listitem> - <listitem><para>NCURSES_BUTTON2_DOUBLE_CLICKED</para></listitem> - <listitem><para>NCURSES_BUTTON2_TRIPLE_CLICKED</para></listitem> - <listitem><para>NCURSES_BUTTON3_PRESSED</para></listitem> - <listitem><para>NCURSES_BUTTON3_RELEASED</para></listitem> - <listitem><para>NCURSES_BUTTON3_CLICKED</para></listitem> - <listitem><para>NCURSES_BUTTON3_DOUBLE_CLICKED</para></listitem> - <listitem><para>NCURSES_BUTTON3_TRIPLE_CLICKED</para></listitem> - <listitem><para>NCURSES_BUTTON4_PRESSED</para></listitem> - <listitem><para>NCURSES_BUTTON4_RELEASED</para></listitem> - <listitem><para>NCURSES_BUTTON4_CLICKED</para></listitem> - <listitem><para>NCURSES_BUTTON4_DOUBLE_CLICKED</para></listitem> - <listitem><para>NCURSES_BUTTON4_TRIPLE_CLICKED</para></listitem> - <listitem><para>NCURSES_BUTTON_SHIFT></para></listitem> - <listitem><para>NCURSES_BUTTON_CTRL</para></listitem> - <listitem><para>NCURSES_BUTTON_ALT</para></listitem> - <listitem><para>NCURSES_ALL_MOUSE_EVENTS</para></listitem> - <listitem><para>NCURSES_REPORT_MOUSE_POSITION</para></listitem> - </itemizedlist> - </para> - <para> - <example> - <title><function>ncurses_mousemask</function> example</title> - <programlisting role="php"> + <refnamediv> + <refname>ncurses_mousemask</refname> + <refpurpose>Sets mouse options</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>int</type><methodname>ncurses_mousemask</methodname> + <methodparam><type>int</type><parameter>newmask</parameter></methodparam> + <methodparam><type>int</type><parameter role="reference">oldmask</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + Sets mouse events to be reported. By default no mouse events will be + reported. + </para> + <para> + Mouse events are represented by NCURSES_KEY_MOUSE in the + <function>ncurses_wgetch</function> input stream. To read the event data + and pop the event of queue, call <function>ncurses_getmouse</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>newmask</parameter></term> + <listitem> + <para> + Mouse mask options can be set with the following predefined constants: + <itemizedlist> + <listitem><para>NCURSES_BUTTON1_PRESSED</para></listitem> + <listitem><para>NCURSES_BUTTON1_RELEASED</para></listitem> + <listitem><para>NCURSES_BUTTON1_CLICKED</para></listitem> + <listitem><para>NCURSES_BUTTON1_DOUBLE_CLICKED</para></listitem> + <listitem><para>NCURSES_BUTTON1_TRIPLE_CLICKED</para></listitem> + <listitem><para>NCURSES_BUTTON2_PRESSED</para></listitem> + <listitem><para>NCURSES_BUTTON2_RELEASED</para></listitem> + <listitem><para>NCURSES_BUTTON2_CLICKED</para></listitem> + <listitem><para>NCURSES_BUTTON2_DOUBLE_CLICKED</para></listitem> + <listitem><para>NCURSES_BUTTON2_TRIPLE_CLICKED</para></listitem> + <listitem><para>NCURSES_BUTTON3_PRESSED</para></listitem> + <listitem><para>NCURSES_BUTTON3_RELEASED</para></listitem> + <listitem><para>NCURSES_BUTTON3_CLICKED</para></listitem> + <listitem><para>NCURSES_BUTTON3_DOUBLE_CLICKED</para></listitem> + <listitem><para>NCURSES_BUTTON3_TRIPLE_CLICKED</para></listitem> + <listitem><para>NCURSES_BUTTON4_PRESSED</para></listitem> + <listitem><para>NCURSES_BUTTON4_RELEASED</para></listitem> + <listitem><para>NCURSES_BUTTON4_CLICKED</para></listitem> + <listitem><para>NCURSES_BUTTON4_DOUBLE_CLICKED</para></listitem> + <listitem><para>NCURSES_BUTTON4_TRIPLE_CLICKED</para></listitem> + <listitem><para>NCURSES_BUTTON_SHIFT></para></listitem> + <listitem><para>NCURSES_BUTTON_CTRL</para></listitem> + <listitem><para>NCURSES_BUTTON_ALT</para></listitem> + <listitem><para>NCURSES_ALL_MOUSE_EVENTS</para></listitem> + <listitem><para>NCURSES_REPORT_MOUSE_POSITION</para></listitem> + </itemizedlist> + </para> + <para> + As a side effect, setting a zero mousemask in + <parameter>newmask</parameter> turns off the mouse + pointer. Setting a non zero value turns mouse pointer on. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>oldmask</parameter></term> + <listitem> + <para> + This will be set to the previous value of the mouse event mask. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a mask to indicated which of the in parameter + <parameter>newmask</parameter> specified mouse events can be reported. On + complete failure, it returns 0. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>ncurses_mousemask</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $newmask = NCURSES_BUTTON1_CLICKED + NCURSES_BUTTON1_RELEASED; $mask = ncurses_mousemask($newmask, &$oldmask); if ($mask & $newmask){ - printf ("All specified mouse options will be supported\n"); + printf("All specified mouse options will be supported\n"); } ?> ]]> - </programlisting> - </example> - </para> - <para> - See also <function>ncurses_getmouse</function>, - <function>ncurses_ungetmouse</function> and - <function>ncurese_getch</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ncurses_getmouse</function></member> + <member><function>ncurses_ungetmouse</function></member> + <member><function>ncurese_getch</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-move-panel.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-move-panel.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-move-panel.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-move-panel.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-move-panel.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-move-panel.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,46 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-move-panel"> <refnamediv> <refname>ncurses_move_panel</refname> <refpurpose>Moves a panel so that its upper-left corner is at [startx, starty]</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_move_panel</methodname> <methodparam><type>resource</type><parameter>panel</parameter></methodparam> <methodparam><type>int</type><parameter>startx</parameter></methodparam> <methodparam><type>int</type><parameter>starty</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>panel</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>startx</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>starty</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-move.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-move.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-move.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-move.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-move.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-move.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-move"> <refnamediv> <refname>ncurses_move</refname> <refpurpose>Move output position </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_move</methodname> <methodparam><type>int</type><parameter>y</parameter></methodparam> <methodparam><type>int</type><parameter>x</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mvaddch.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mvaddch.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mvaddch.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-mvaddch.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-mvaddch.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mvaddch.xml Mon Jan 15 23:41:54 2007 @@ -1,22 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-mvaddch"> <refnamediv> <refname>ncurses_mvaddch</refname> <refpurpose>Move current position and add character </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_mvaddch</methodname> <methodparam><type>int</type><parameter>y</parameter></methodparam> <methodparam><type>int</type><parameter>x</parameter></methodparam> <methodparam><type>int</type><parameter>c</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>c</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mvaddchnstr.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mvaddchnstr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mvaddchnstr.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-mvaddchnstr.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-mvaddchnstr.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mvaddchnstr.xml Mon Jan 15 23:41:54 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-mvaddchnstr"> <refnamediv> <refname>ncurses_mvaddchnstr</refname> <refpurpose>Move position and add attributed string with specified length </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_mvaddchnstr</methodname> <methodparam><type>int</type><parameter>y</parameter></methodparam> @@ -15,9 +14,42 @@ <methodparam><type>string</type><parameter>s</parameter></methodparam> <methodparam><type>int</type><parameter>n</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>s</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>n</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mvaddchstr.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mvaddchstr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mvaddchstr.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-mvaddchstr.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-mvaddchstr.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mvaddchstr.xml Mon Jan 15 23:41:54 2007 @@ -1,22 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-mvaddchstr"> <refnamediv> <refname>ncurses_mvaddchstr</refname> <refpurpose>Move position and add attributed string </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_mvaddchstr</methodname> <methodparam><type>int</type><parameter>y</parameter></methodparam> <methodparam><type>int</type><parameter>x</parameter></methodparam> <methodparam><type>string</type><parameter>s</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>s</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mvaddnstr.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mvaddnstr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mvaddnstr.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-mvaddnstr.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-mvaddnstr.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mvaddnstr.xml Mon Jan 15 23:41:54 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-mvaddnstr"> <refnamediv> <refname>ncurses_mvaddnstr</refname> <refpurpose>Move position and add string with specified length </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_mvaddnstr</methodname> <methodparam><type>int</type><parameter>y</parameter></methodparam> @@ -15,9 +14,42 @@ <methodparam><type>string</type><parameter>s</parameter></methodparam> <methodparam><type>int</type><parameter>n</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>s</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>n</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mvaddstr.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mvaddstr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mvaddstr.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-mvaddstr.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-mvaddstr.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mvaddstr.xml Mon Jan 15 23:41:54 2007 @@ -1,22 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-mvaddstr"> <refnamediv> <refname>ncurses_mvaddstr</refname> <refpurpose>Move position and add string </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_mvaddstr</methodname> <methodparam><type>int</type><parameter>y</parameter></methodparam> <methodparam><type>int</type><parameter>x</parameter></methodparam> <methodparam><type>string</type><parameter>s</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>s</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mvcur.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mvcur.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mvcur.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-mvcur.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-mvcur.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mvcur.xml Mon Jan 15 23:41:54 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-mvcur"> <refnamediv> <refname>ncurses_mvcur</refname> <refpurpose>Move cursor immediately </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_mvcur</methodname> <methodparam><type>int</type><parameter>old_y</parameter></methodparam> @@ -15,9 +14,42 @@ <methodparam><type>int</type><parameter>new_y</parameter></methodparam> <methodparam><type>int</type><parameter>new_x</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>old_y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>old_x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>new_y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>new_x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mvdelch.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mvdelch.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mvdelch.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-mvdelch.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-mvdelch.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mvdelch.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-mvdelch"> <refnamediv> <refname>ncurses_mvdelch</refname> <refpurpose>Move position and delete character, shift rest of line left </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_mvdelch</methodname> <methodparam><type>int</type><parameter>y</parameter></methodparam> <methodparam><type>int</type><parameter>x</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mvgetch.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mvgetch.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mvgetch.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-mvgetch.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-mvgetch.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mvgetch.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-mvgetch"> <refnamediv> <refname>ncurses_mvgetch</refname> <refpurpose>Move position and get character at new position </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_mvgetch</methodname> <methodparam><type>int</type><parameter>y</parameter></methodparam> <methodparam><type>int</type><parameter>x</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mvhline.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mvhline.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mvhline.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-mvhline.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-mvhline.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mvhline.xml Mon Jan 15 23:41:54 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-mvhline"> <refnamediv> <refname>ncurses_mvhline</refname> <refpurpose>Set new position and draw a horizontal line using an attributed character and max. n characters long </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_mvhline</methodname> <methodparam><type>int</type><parameter>y</parameter></methodparam> @@ -15,9 +14,42 @@ <methodparam><type>int</type><parameter>attrchar</parameter></methodparam> <methodparam><type>int</type><parameter>n</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrchar</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>n</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mvinch.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mvinch.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mvinch.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-mvinch.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-mvinch.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mvinch.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-mvinch"> <refnamediv> <refname>ncurses_mvinch</refname> <refpurpose>Move position and get attributed character at new position </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_mvinch</methodname> <methodparam><type>int</type><parameter>y</parameter></methodparam> <methodparam><type>int</type><parameter>x</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mvvline.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mvvline.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mvvline.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-mvvline.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-mvvline.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mvvline.xml Mon Jan 15 23:41:54 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-mvvline"> <refnamediv> <refname>ncurses_mvvline</refname> <refpurpose>Set new position and draw a vertical line using an attributed character and max. n characters long </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_mvvline</methodname> <methodparam><type>int</type><parameter>y</parameter></methodparam> @@ -15,9 +14,42 @@ <methodparam><type>int</type><parameter>attrchar</parameter></methodparam> <methodparam><type>int</type><parameter>n</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrchar</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>n</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-mvwaddstr.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-mvwaddstr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-mvwaddstr.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-mvwaddstr.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-mvwaddstr.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-mvwaddstr.xml Mon Jan 15 23:41:54 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-mvwaddstr"> <refnamediv> <refname>ncurses_mvwaddstr</refname> <refpurpose>Add string at new position in window </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_mvwaddstr</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> @@ -15,9 +14,42 @@ <methodparam><type>int</type><parameter>x</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-napms.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-napms.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-napms.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-napms.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-napms.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-napms.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-napms"> <refnamediv> <refname>ncurses_napms</refname> <refpurpose>Sleep</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_napms</methodname> <methodparam><type>int</type><parameter>milliseconds</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>milliseconds</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-new-panel.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-new-panel.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-new-panel.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-new-panel.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-new-panel.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-new-panel.xml Mon Jan 15 23:41:54 2007 @@ -1,19 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-new-panel"> <refnamediv> <refname>ncurses_new_panel</refname> <refpurpose>Create a new panel and associate it with window</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ncurses_new_panel</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-newpad.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-newpad.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-newpad.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-newpad.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-newpad.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-newpad.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,38 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-newpad"> <refnamediv> <refname>ncurses_newpad</refname> <refpurpose>Creates a new pad (window)</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ncurses_newpad</methodname> <methodparam><type>int</type><parameter>rows</parameter></methodparam> <methodparam><type>int</type><parameter>cols</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>rows</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>cols</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-newwin.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-newwin.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-newwin.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-newwin.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-newwin.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-newwin.xml Mon Jan 15 23:41:54 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-newwin"> <refnamediv> <refname>ncurses_newwin</refname> <refpurpose>Create a new window</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ncurses_newwin</methodname> <methodparam><type>int</type><parameter>rows</parameter></methodparam> @@ -16,17 +15,59 @@ <methodparam><type>int</type><parameter>x</parameter></methodparam> </methodsynopsis> &warn.experimental.func; - <simpara> - <function>ncurses_newwin</function> creates a new window - to draw elements in. Windows can be positioned using - <parameter>x</parameter>, <parameter>y</parameter>, - <parameter>rows</parameter> and <parameter>cols</parameter>. - When creating additional windows, - remember to use <function>ncurses_getmaxyx</function> to check for - available space, as terminal size is individual and may vary. - The return value is a resource ID used to differ between multiple - windows. - </simpara> + <para> + Creates a new window to draw elements in. + </para> + <para> + When creating additional windows, remember to use + <function>ncurses_getmaxyx</function> to check for available space, as + terminal size is individual and may vary. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>rows</parameter></term> + <listitem> + <para> + Number of rows + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>cols</parameter></term> + <listitem> + <para> + Number of columns + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + y-ccordinate of the origin + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + x-ccordinate of the origin + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a resource ID for the new window. + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-nl.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-nl.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-nl.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-nl.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-nl.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-nl.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-nl"> <refnamediv> <refname>ncurses_nl</refname> <refpurpose>Translate newline and carriage return / line feed </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_nl</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-nocbreak.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-nocbreak.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-nocbreak.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-nocbreak.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-nocbreak.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-nocbreak.xml Mon Jan 15 23:41:54 2007 @@ -1,28 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-nocbreak"> <refnamediv> <refname>ncurses_nocbreak</refname> <refpurpose>Switch terminal to cooked mode </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_nocbreak</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_nocbreak</function> routine returns terminal to - normal (cooked) mode. Initially the terminal may or may not in - cbreak mode as the mode is inherited. Therefore a program should - call <function>ncurses_cbreak</function> and + Returns terminal to normal (cooked) mode. Initially the terminal may or + may not in cbreak mode as the mode is inherited. Therefore a program + should call <function>ncurses_cbreak</function> and <function>ncurses_nocbreak</function> explicitly. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns &true; if any error occurred, otherwise &false;. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_cbreak</function> + <simplelist> + <member><function>ncurses_cbreak</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-noecho.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-noecho.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-noecho.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-noecho.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-noecho.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-noecho.xml Mon Jan 15 23:41:54 2007 @@ -1,26 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-noecho"> <refnamediv> <refname>ncurses_noecho</refname> <refpurpose>Switch off keyboard input echo </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_noecho</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> - <function>ncurses_noecho</function> prevents echoing of user - typed characters. - Returns &true; if any error occurred, otherwise &false;. + Prevents echoing of user typed characters. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if any error occurred, &false; otherwise. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_echo</function>, - <function>ncurses_getch</function> + <simplelist> + <member><function>ncurses_echo</function></member> + <member><function>ncurses_getch</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-nonl.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-nonl.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-nonl.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-nonl.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-nonl.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-nonl.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-nonl"> <refnamediv> <refname>ncurses_nonl</refname> <refpurpose>Do not translate newline and carriage return / line feed </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_nonl</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-noqiflush.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-noqiflush.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-noqiflush.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-noqiflush.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-noqiflush.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-noqiflush.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-noqiflush"> <refnamediv> <refname>ncurses_noqiflush</refname> <refpurpose>Do not flush on signal characters</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>ncurses_noqiflush</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-noraw.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-noraw.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-noraw.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-noraw.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-noraw.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-noraw.xml Mon Jan 15 23:41:54 2007 @@ -1,31 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-noraw"> <refnamediv> <refname>ncurses_noraw</refname> <refpurpose>Switch terminal out of raw mode </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_noraw</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + <para> + Switches the terminal out of raw mode. Raw mode is similar to cbreak mode, + in that characters typed are immediately passed through to the user + program. The differences that are that in raw mode, the interrupt, quit, + suspend and flow control characters are all passed through uninterpreted, + instead of generating a signal. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>ncurses_noraw</function> switches the terminal out of raw - mode. Raw mode is similar to cbreak mode, in that characters - typed are immediately passed through to the user program. The - differences that are that in raw mode, the interrupt, quit, - suspend and flow control characters are all passed through - uninterpreted, instead of generating a signal. Returns &true; if any error occurred, otherwise &false;. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_raw</function>, - <function>ncurses_cbreak</function>, - <function>ncurses_nocbreak</function> + <simplelist> + <member><function>ncurses_raw</function></member> + <member><function>ncurses_cbreak</function></member> + <member><function>ncurses_nocbreak</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-pair-content.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-pair-content.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-pair-content.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-pair-content.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-pair-content.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-pair-content.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,46 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-pair-content"> <refnamediv> <refname>ncurses_pair_content</refname> <refpurpose>Gets the RGB value for color</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_pair_content</methodname> <methodparam><type>int</type><parameter>pair</parameter></methodparam> <methodparam><type>int</type><parameter role="reference">f</parameter></methodparam> <methodparam><type>int</type><parameter role="reference">b</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>pair</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>f</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>b</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-panel-above.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-panel-above.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-panel-above.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-panel-above.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-panel-above.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-panel-above.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,34 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-panel-above"> <refnamediv> <refname>ncurses_panel_above</refname> <refpurpose>Returns the panel above panel</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ncurses_panel_above</methodname> <methodparam><type>resource</type><parameter>panel</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>panel</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> If panel is null, returns the bottom panel in the stack. </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-panel-below.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-panel-below.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-panel-below.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-panel-below.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-panel-below.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-panel-below.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,34 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.4 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-panel-below"> <refnamediv> <refname>ncurses_panel_below</refname> <refpurpose>Returns the panel below panel</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ncurses_panel_below</methodname> <methodparam><type>resource</type><parameter>panel</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>panel</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> If panel is null, returns the top panel in the stack. </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-panel-window.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-panel-window.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-panel-window.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-panel-window.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-panel-window.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-panel-window.xml Mon Jan 15 23:41:54 2007 @@ -1,19 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-panel-window"> <refnamediv> <refname>ncurses_panel_window</refname> <refpurpose>Returns the window associated with panel</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>ncurses_panel_window</methodname> <methodparam><type>resource</type><parameter>panel</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>panel</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-pnoutrefresh.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-pnoutrefresh.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-pnoutrefresh.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-pnoutrefresh.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-pnoutrefresh.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-pnoutrefresh.xml Mon Jan 15 23:41:54 2007 @@ -1,13 +1,12 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-pnoutrefresh"> <refnamediv> <refname>ncurses_pnoutrefresh</refname> <refpurpose>Copies a region from a pad into the virtual screen</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_pnoutrefresh</methodname> <methodparam><type>resource</type><parameter>pad</parameter></methodparam> @@ -18,8 +17,62 @@ <methodparam><type>int</type><parameter>smaxrow</parameter></methodparam> <methodparam><type>int</type><parameter>smaxcol</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>pad</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pminrow</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pmincol</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>sminrow</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>smincol</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>smaxrow</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>smaxcol</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-prefresh.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-prefresh.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-prefresh.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-prefresh.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-prefresh.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-prefresh.xml Mon Jan 15 23:41:54 2007 @@ -1,13 +1,12 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-prefresh"> <refnamediv> <refname>ncurses_prefresh</refname> <refpurpose>Copies a region from a pad into the virtual screen</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_prefresh</methodname> <methodparam><type>resource</type><parameter>pad</parameter></methodparam> @@ -18,8 +17,62 @@ <methodparam><type>int</type><parameter>smaxrow</parameter></methodparam> <methodparam><type>int</type><parameter>smaxcol</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>pad</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pminrow</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pmincol</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>sminrow</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>smincol</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>smaxrow</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>smaxcol</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-putp.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-putp.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-putp.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-putp.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-putp.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-putp.xml Mon Jan 15 23:41:54 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-putp"> <refnamediv> <refname>ncurses_putp</refname> <refpurpose>Apply padding information to the string and output it</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_putp</methodname> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-qiflush.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-qiflush.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-qiflush.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-qiflush.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-qiflush.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-qiflush.xml Mon Jan 15 23:41:54 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-qiflush"> <refnamediv> <refname>ncurses_qiflush</refname> <refpurpose>Flush on signal characters </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>ncurses_qiflush</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-raw.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-raw.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-raw.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-raw.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-raw.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-raw.xml Mon Jan 15 23:41:55 2007 @@ -1,31 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-raw"> <refnamediv> <refname>ncurses_raw</refname> <refpurpose>Switch terminal into raw mode </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_raw</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + <para> + Places the terminal in raw mode. Raw mode is similar to cbreak mode, in + that characters typed are immediately passed through to the user program. + The differences that are that in raw mode, the interrupt, quit, suspend + and flow control characters are all passed through uninterpreted, instead + of generating a signal. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - <function>ncurses_raw</function> places the terminal in raw - mode. Raw mode is similar to cbreak mode, in that characters - typed are immediately passed through to the user program. The - differences that are that in raw mode, the interrupt, quit, - suspend and flow control characters are all passed through - uninterpreted, instead of generating a signal. Returns &true; if any error occurred, otherwise &false;. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_noraw</function>, - <function>ncurses_cbreak</function>, - <function>ncurses_nocbreak</function> + <simplelist> + <member><function>ncurses_noraw</function></member> + <member><function>ncurses_cbreak</function></member> + <member><function>ncurses_nocbreak</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-refresh.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-refresh.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-refresh.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-refresh.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-refresh.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-refresh.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-refresh"> <refnamediv> <refname>ncurses_refresh</refname> <refpurpose>Refresh screen </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_refresh</methodname> <methodparam><type>int</type><parameter>ch</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>ch</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-replace-panel.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-replace-panel.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-replace-panel.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-replace-panel.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-replace-panel.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-replace-panel.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,38 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-replace-panel"> <refnamediv> <refname>ncurses_replace_panel</refname> <refpurpose>Replaces the window associated with panel</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_replace_panel</methodname> <methodparam><type>resource</type><parameter>panel</parameter></methodparam> <methodparam><type>resource</type><parameter>window</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>panel</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-reset-prog-mode.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-reset-prog-mode.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-reset-prog-mode.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-reset-prog-mode.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-reset-prog-mode.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-reset-prog-mode.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,17 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-reset-prog-mode"> <refnamediv> <refname>ncurses_reset_prog_mode</refname> <refpurpose>Resets the prog mode saved by def_prog_mode</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_reset_prog_mode</methodname> <void/> </methodsynopsis> - <para> - &warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-reset-shell-mode.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-reset-shell-mode.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-reset-shell-mode.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-reset-shell-mode.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-reset-shell-mode.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-reset-shell-mode.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,17 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-reset-shell-mode"> <refnamediv> <refname>ncurses_reset_shell_mode</refname> <refpurpose>Resets the shell mode saved by def_shell_mode</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_reset_shell_mode</methodname> <void/> </methodsynopsis> - <para> - &warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-resetty.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-resetty.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-resetty.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-resetty.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-resetty.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-resetty.xml Mon Jan 15 23:41:55 2007 @@ -1,26 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-resetty"> <refnamediv> <refname>ncurses_resetty</refname> <refpurpose>Restores saved terminal state </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_resetty</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> - Function <function>ncurses_resetty</function> restores the - terminal state, which was previously saved by calling + Restores the terminal state, which was previously saved by calling <function>ncurses_savetty</function>. - This function always returns &false;. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Always returns &false;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_savetty</function> + <simplelist> + <member><function>ncurses_savetty</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-savetty.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-savetty.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-savetty.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-savetty.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-savetty.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-savetty.xml Mon Jan 15 23:41:55 2007 @@ -1,26 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.5 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-savetty"> <refnamediv> <refname>ncurses_savetty</refname> <refpurpose>Saves terminal state </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_savetty</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - Function <function>ncurses_savetty</function> saves the current - terminal state. The saved terminal state can be restored with - function <function>ncurses_resetty</function>. - <function>ncurses_savetty</function> always returns &false;. + Saves the current terminal state. The saved terminal state can be restored + with <function>ncurses_resetty</function>. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Always returns &false;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also: <function>ncurses_resetty</function> + <simplelist> + <member><function>ncurses_resetty</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-scr-dump.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-scr-dump.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-scr-dump.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-scr-dump.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-scr-dump.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-scr-dump.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-scr-dump"> <refnamediv> <refname>ncurses_scr_dump</refname> <refpurpose>Dump screen content to file </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_scr_dump</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-scr-init.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-scr-init.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-scr-init.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-scr-init.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-scr-init.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-scr-init.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-scr-init"> <refnamediv> <refname>ncurses_scr_init</refname> <refpurpose>Initialize screen from file dump </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_scr_init</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-scr-restore.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-scr-restore.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-scr-restore.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-scr-restore.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-scr-restore.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-scr-restore.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-scr-restore"> <refnamediv> <refname>ncurses_scr_restore</refname> <refpurpose>Restore screen from file dump </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_scr_restore</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-scr-set.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-scr-set.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-scr-set.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-scr-set.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-scr-set.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-scr-set.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-scr-set"> <refnamediv> <refname>ncurses_scr_set</refname> <refpurpose>Inherit screen from file dump </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_scr_set</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-scrl.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-scrl.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-scrl.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-scrl.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-scrl.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-scrl.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-scrl"> <refnamediv> <refname>ncurses_scrl</refname> <refpurpose>Scroll window content up or down without changing current position </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_scrl</methodname> <methodparam><type>int</type><parameter>count</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>count</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-show-panel.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-show-panel.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-show-panel.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-show-panel.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-show-panel.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-show-panel.xml Mon Jan 15 23:41:55 2007 @@ -1,19 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-show-panel"> <refnamediv> <refname>ncurses_show_panel</refname> <refpurpose>Places an invisible panel on top of the stack, making it visible</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_show_panel</methodname> <methodparam><type>resource</type><parameter>panel</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>panel</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-slk-attr.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-slk-attr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-slk-attr.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-slk-attr.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-slk-attr.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-slk-attr.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-slk-attr"> <refnamediv> <refname>ncurses_slk_attr</refname> <refpurpose>Returns current soft label key attribute</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>bool</type><methodname>ncurses_slk_attr</methodname> + <type>int</type><methodname>ncurses_slk_attr</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_slk_attr</function> returns the current soft - label key attribute. On error returns &true;, otherwise &false;. + Returns the current soft label key attribute. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The attribute, as an integer. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-slk-attroff.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-slk-attroff.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-slk-attroff.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-slk-attroff.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-slk-attroff.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-slk-attroff.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-slk-attroff"> <refnamediv> <refname>ncurses_slk_attroff</refname> <refpurpose>Turn off the given attributes for soft function-key labels</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_slk_attroff</methodname> <methodparam><type>int</type><parameter>intarg</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>intarg</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-slk-attron.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-slk-attron.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-slk-attron.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-slk-attron.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-slk-attron.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-slk-attron.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-slk-attron"> <refnamediv> <refname>ncurses_slk_attron</refname> <refpurpose>Turn on the given attributes for soft function-key labels</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_slk_attron</methodname> <methodparam><type>int</type><parameter>intarg</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>intarg</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-slk-attrset.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-slk-attrset.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-slk-attrset.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-slk-attrset.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-slk-attrset.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-slk-attrset.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-slk-attrset"> <refnamediv> <refname>ncurses_slk_attrset</refname> <refpurpose>Set given attributes for soft function-key labels</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_slk_attrset</methodname> <methodparam><type>int</type><parameter>intarg</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>intarg</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-slk-clear.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-slk-clear.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-slk-clear.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-slk-clear.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-slk-clear.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-slk-clear.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,26 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-slk-clear"> <refnamediv> <refname>ncurses_slk_clear</refname> <refpurpose>Clears soft labels from screen</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_slk_clear</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> The function <function>ncurses_slk_clear</function> clears soft - label keys from screen. Returns &true; on error, otherwise &false;. + label keys from screen. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; on errors, &false; otherwise. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-slk-color.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-slk-color.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-slk-color.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-slk-color.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-slk-color.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-slk-color.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-slk-color"> <refnamediv> <refname>ncurses_slk_color</refname> <refpurpose>Sets color for soft label keys</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_slk_color</methodname> <methodparam><type>int</type><parameter>intarg</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>intarg</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-slk-init.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-slk-init.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-slk-init.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-slk-init.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-slk-init.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-slk-init.xml Mon Jan 15 23:41:55 2007 @@ -1,29 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-slk-init"> <refnamediv> <refname>ncurses_slk_init</refname> <refpurpose>Initializes soft label key functions</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_slk_init</methodname> <methodparam><type>int</type><parameter>format</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - Function <function>ncurses_slk_init</function> must be called - before <function>ncurses_initscr</function> or - <function>ncurses_newterm</function> is called. If - <function>ncurses_initscr</function> eventually uses a line from - stdscr to emulate the soft labels, then - <parameter>format</parameter> determines how the labels are - arranged of the screen. Setting <parameter>format</parameter> to - 0 indicates a 3-2-3 arrangement of the labels, 1 indicates a 4-4 - arrangement and 2 indicates the PC like 4-4-4 mode, but in - addition an index line will be created. + Initializes soft label key functions + </para> + <para> + This function must be called before <function>ncurses_initscr</function> + or <function>ncurses_newterm</function> is called. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>format</parameter></term> + <listitem> + <para> + If <function>ncurses_initscr</function> eventually uses a line from + stdscr to emulate the soft labels, then this parameter determines how + the labels are arranged of the screen. + </para> + <para> + 0 indicates a 3-2-3 arrangement of the labels, 1 indicates a 4-4 + arrangement and 2 indicates the PC like 4-4-4 mode, but in addition an + index line will be created. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-slk-noutrefresh.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-slk-noutrefresh.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-slk-noutrefresh.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-slk-noutrefresh.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-slk-noutrefresh.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-slk-noutrefresh.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-slk-noutrefresh"> <refnamediv> <refname>ncurses_slk_noutrefresh</refname> <refpurpose>Copies soft label keys to virtual screen</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_slk_noutrefresh</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-slk-refresh.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-slk-refresh.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-slk-refresh.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-slk-refresh.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-slk-refresh.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-slk-refresh.xml Mon Jan 15 23:41:55 2007 @@ -1,22 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-slk-refresh"> <refnamediv> <refname>ncurses_slk_refresh</refname> <refpurpose>Copies soft label keys to screen</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>bool</type><methodname>ncurses_slk_refresh</methodname> + <type>int</type><methodname>ncurses_slk_refresh</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - <function>ncurses_slk_refresh</function> copies soft label keys - from virtual screen to physical screen. Returns &true; on error, - otherwise &false;. + Copies soft label keys from virtual screen to physical screen. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-slk-restore.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-slk-restore.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-slk-restore.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-slk-restore.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-slk-restore.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-slk-restore.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-slk-restore"> <refnamediv> <refname>ncurses_slk_restore</refname> <refpurpose>Restores soft label keys</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>bool</type><methodname>ncurses_slk_restore</methodname> + <type>int</type><methodname>ncurses_slk_restore</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - The function <function>ncurses_slk_restore</function> restores - the soft label keys after <function>ncurses_slk_clear</function> + Restores the soft label keys after <function>ncurses_slk_clear</function> has been performed. </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-slk-set.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-slk-set.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-slk-set.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-slk-set.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-slk-set.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-slk-set.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,46 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-slk-set"> <refnamediv> <refname>ncurses_slk_set</refname> <refpurpose>Sets function key labels</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_slk_set</methodname> <methodparam><type>int</type><parameter>labelnr</parameter></methodparam> <methodparam><type>string</type><parameter>label</parameter></methodparam> <methodparam><type>int</type><parameter>format</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>labelnr</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>label</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>format</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-slk-touch.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-slk-touch.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-slk-touch.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-slk-touch.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-slk-touch.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-slk-touch.xml Mon Jan 15 23:41:55 2007 @@ -1,22 +1,20 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-slk-touch"> <refnamediv> <refname>ncurses_slk_touch</refname> <refpurpose>Forces output when ncurses_slk_noutrefresh is performed</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>bool</type><methodname>ncurses_slk_touch</methodname> + <type>int</type><methodname>ncurses_slk_touch</methodname> <void/> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; <para> - The <function>ncurses_slk_touch</function> function forces all the soft - labels to be output the next time a - <function>ncurses_slk_noutrefresh</function> is performed. + Forces all the soft labels to be output the next time a + <function>ncurses_slk_noutrefresh</function> is performed. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-standend.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-standend.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-standend.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-standend.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-standend.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-standend.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-standend"> <refnamediv> <refname>ncurses_standend</refname> <refpurpose>Stop using 'standout' attribute </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_standend</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-standout.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-standout.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-standout.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-standout.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-standout.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-standout.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-standout"> <refnamediv> <refname>ncurses_standout</refname> <refpurpose>Start using 'standout' attribute </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_standout</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-start-color.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-start-color.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-start-color.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-start-color.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-start-color.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-start-color.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-start-color"> <refnamediv> <refname>ncurses_start_color</refname> <refpurpose>Start using colors </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_start_color</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-termattrs.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-termattrs.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-termattrs.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-termattrs.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-termattrs.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-termattrs.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-termattrs"> <refnamediv> <refname>ncurses_termattrs</refname> <refpurpose>Returns a logical OR of all attribute flags supported by terminal </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_termattrs</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-termname.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-termname.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-termname.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-termname.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-termname.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-termname.xml Mon Jan 15 23:41:55 2007 @@ -1,28 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.5 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-termname"> - <refnamediv> - <refname>ncurses_termname</refname> - <refpurpose>Returns terminals (short)-name</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ncurses_termname</methodname> - <void/> - </methodsynopsis> - &warn.experimental.func; - <para> - <function>ncurses_termname</function> returns terminals - shortname. The shortname is truncated to 14 characters. - On error <function>ncurses_termname</function> returns NULL. - </para> - <para> - See also: <function>ncurses_longname</function> - </para> - </refsect1> - </refentry> + <refnamediv> + <refname>ncurses_termname</refname> + <refpurpose>Returns terminals (short)-name</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>ncurses_termname</methodname> + <void/> + </methodsynopsis> + &warn.experimental.func; + <para> + Returns terminals shortname. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the shortname of the terminal, truncated to 14 characters. + On errors, returns &null;. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ncurses_longname</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-timeout.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-timeout.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-timeout.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-timeout.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-timeout.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-timeout.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-timeout"> <refnamediv> <refname>ncurses_timeout</refname> <refpurpose>Set timeout for special key sequences </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>ncurses_timeout</methodname> <methodparam><type>int</type><parameter>millisec</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>millisec</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-top-panel.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-top-panel.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-top-panel.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-top-panel.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-top-panel.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-top-panel.xml Mon Jan 15 23:41:55 2007 @@ -1,19 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-top-panel"> <refnamediv> <refname>ncurses_top_panel</refname> <refpurpose>Moves a visible panel to the top of the stack</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_top_panel</methodname> <methodparam><type>resource</type><parameter>panel</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>panel</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-typeahead.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-typeahead.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-typeahead.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-typeahead.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-typeahead.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-typeahead.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-typeahead"> <refnamediv> <refname>ncurses_typeahead</refname> <refpurpose>Specify different filedescriptor for typeahead checking </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_typeahead</methodname> <methodparam><type>int</type><parameter>fd</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>fd</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-ungetch.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-ungetch.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-ungetch.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-ungetch.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-ungetch.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-ungetch.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-ungetch"> <refnamediv> <refname>ncurses_ungetch</refname> <refpurpose>Put a character back into the input stream </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_ungetch</methodname> <methodparam><type>int</type><parameter>keycode</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>keycode</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-ungetmouse.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-ungetmouse.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-ungetmouse.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-ungetmouse.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-ungetmouse.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-ungetmouse.xml Mon Jan 15 23:41:55 2007 @@ -1,46 +1,70 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-ungetmouse"> - <refnamediv> - <refname>ncurses_ungetmouse</refname> - <refpurpose>Pushes mouse event to queue</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ncurses_ungetmouse</methodname> - <methodparam><type>array</type><parameter>mevent</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - <function>ncurses_getmouse</function> pushes a KEY_MOUSE event - onto the unput queue and associates with this event the given - state sata and screen-relative character cell coordinates, - specified in <parameter>mevent</parameter>. - - Event options will be specified in associative array - <parameter>mevent</parameter>: - <itemizedlist> - <listitem><para>"id" : Id to distinguish multiple - devices</para></listitem> - <listitem><para>"x" : screen relative x-position in character - cells</para></listitem> - <listitem><para>"y" : screen relative y-position in character - cells</para></listitem> - <listitem><para>"z" : currently not supported</para></listitem> - <listitem><para>"mmask" : Mouse action</para></listitem> - </itemizedlist> - </para> - <para> - <function>ncurses_ungetmouse</function> returns &false; on - success, otherwise &true;. - </para> - <para> - See also: <function>ncurses_getmouse</function> - </para> - </refsect1> - </refentry> + <refnamediv> + <refname>ncurses_ungetmouse</refname> + <refpurpose>Pushes mouse event to queue</refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>bool</type><methodname>ncurses_ungetmouse</methodname> + <methodparam><type>array</type><parameter>mevent</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + Pushes a KEY_MOUSE event onto the unput queue and associates with this + event the given state sata and screen-relative character cell coordinates, + specified in <parameter>mevent</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>mevent</parameter></term> + <listitem> + <para> + An associative array specifying the event options: + <itemizedlist> + <listitem> + <para>"id" : Id to distinguish multiple devices</para> + </listitem> + <listitem> + <para>"x" : screen relative x-position in character cells</para> + </listitem> + <listitem> + <para>"y" : screen relative y-position in character cells</para> + </listitem> + <listitem> + <para>"z" : currently not supported</para> + </listitem> + <listitem> + <para>"mmask" : Mouse action</para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &false; on success, &true; otherwise. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ncurses_getmouse</function></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-update-panels.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-update-panels.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-update-panels.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-update-panels.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-update-panels.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-update-panels.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,17 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-update-panels"> <refnamediv> <refname>ncurses_update_panels</refname> <refpurpose>Refreshes the virtual screen to reflect the relations between panels in the stack</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>ncurses_update_panels</methodname> <void/> </methodsynopsis> - <para> - &warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-use-default-colors.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-use-default-colors.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-use-default-colors.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-use-default-colors.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-use-default-colors.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-use-default-colors.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,18 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-use-default-colors"> <refnamediv> <refname>ncurses_use_default_colors</refname> <refpurpose>Assign terminal default colors to color id -1 </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_use_default_colors</methodname> <void/> </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> + &warn.experimental.func; + &warn.undocumented.func; </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-use-env.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-use-env.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-use-env.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-use-env.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-use-env.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-use-env.xml Mon Jan 15 23:41:55 2007 @@ -1,23 +1,34 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.5 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-use-env"> - <refnamediv> - <refname>ncurses_use_env</refname> - <refpurpose>Control use of environment information about terminal size </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>ncurses_use_env</methodname> - <methodparam><type>bool</type><parameter>flag</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - &warn.undocumented.func; - </para> - </refsect1> - </refentry> + <refnamediv> + <refname>ncurses_use_env</refname> + <refpurpose>Control use of environment information about terminal size </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>void</type><methodname>ncurses_use_env</methodname> + <methodparam><type>bool</type><parameter>flag</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>flag</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-use-extended-names.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-use-extended-names.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-use-extended-names.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-use-extended-names.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-use-extended-names.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-use-extended-names.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-use-extended-names"> <refnamediv> <refname>ncurses_use_extended_names</refname> <refpurpose>Control use of extended names in terminfo descriptions </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_use_extended_names</methodname> <methodparam><type>bool</type><parameter>flag</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>flag</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-vidattr.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-vidattr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-vidattr.xml:1.5 phpdoc/en/reference/ncurses/functions/ncurses-vidattr.xml:1.6 --- phpdoc/en/reference/ncurses/functions/ncurses-vidattr.xml:1.5 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-vidattr.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.ncurses-vidattr"> <refnamediv> <refname>ncurses_vidattr</refname> <refpurpose>Display the string on the terminal in the video attribute mode</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_vidattr</methodname> <methodparam><type>int</type><parameter>intarg</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>intarg</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-vline.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-vline.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-vline.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-vline.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-vline.xml:1.4 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-vline.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-vline"> <refnamediv> <refname>ncurses_vline</refname> <refpurpose>Draw a vertical line at current position using an attributed character and max. n characters long </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_vline</methodname> <methodparam><type>int</type><parameter>charattr</parameter></methodparam> <methodparam><type>int</type><parameter>n</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>charattr</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>n</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-waddch.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-waddch.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-waddch.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-waddch.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-waddch.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-waddch.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,38 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-waddch"> <refnamediv> <refname>ncurses_waddch</refname> <refpurpose>Adds character at current position in a window and advance cursor</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_waddch</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> <methodparam><type>int</type><parameter>ch</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ch</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-waddstr.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-waddstr.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-waddstr.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-waddstr.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-waddstr.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-waddstr.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,46 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-waddstr"> <refnamediv> <refname>ncurses_waddstr</refname> <refpurpose>Outputs text at current postion in window</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_waddstr</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> <methodparam><type>string</type><parameter>str</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>n</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>n</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wattroff.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wattroff.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wattroff.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-wattroff.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-wattroff.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wattroff.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,38 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-wattroff"> <refnamediv> <refname>ncurses_wattroff</refname> <refpurpose>Turns off attributes for a window</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_wattroff</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> <methodparam><type>int</type><parameter>attrs</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrs</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wattron.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wattron.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wattron.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-wattron.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-wattron.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wattron.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,38 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-wattron"> <refnamediv> <refname>ncurses_wattron</refname> <refpurpose>Turns on attributes for a window</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_wattron</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> <methodparam><type>int</type><parameter>attrs</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrs</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wattrset.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wattrset.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wattrset.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-wattrset.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-wattrset.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wattrset.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,38 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-wattrset"> <refnamediv> <refname>ncurses_wattrset</refname> <refpurpose>Set the attributes for a window</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_wattrset</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> <methodparam><type>int</type><parameter>attrs</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>attrs</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wborder.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wborder.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wborder.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-wborder.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-wborder.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wborder.xml Mon Jan 15 23:41:55 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-wborder"> <refnamediv> <refname>ncurses_wborder</refname> <refpurpose>Draws a border around the window using attributed characters</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_wborder</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> @@ -21,19 +20,98 @@ <methodparam><type>int</type><parameter>br_corner</parameter></methodparam> </methodsynopsis> &warn.experimental.func; - <simpara> - <function>ncurses_wborder</function> draws the specified lines and - corners around the passed window <parameter>window</parameter>. Each - parameter expects 0 to draw a line and 1 to skip it. The corners are - top left, top right, bottom left and bottom right. - </simpara> - <simpara> + <para> + Draws the specified lines and corners around the passed + <parameter>window</parameter>. + </para> + <para> Use <function>ncurses_border</function> for borders around the main window. - </simpara> - <simpara> - See also <function>ncurses_border</function>. - </simpara> + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + Each parameter expects 0 to draw a line and 1 to skip it. + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + The window on which we operate + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>left</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>right</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>top</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>bottom</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tl_corner</parameter></term> + <listitem> + <para> + Top left corner + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>tr_corner</parameter></term> + <listitem> + <para> + Top right corner + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>bl_corner</parameter></term> + <listitem> + <para> + Bottom left corner + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>br_corner</parameter></term> + <listitem> + <para> + Bottom right corner + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ncurses_border</function></member> + </simplelist> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wclear.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wclear.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wclear.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-wclear.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-wclear.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wclear.xml Mon Jan 15 23:41:55 2007 @@ -1,19 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-wclear"> <refnamediv> <refname>ncurses_wclear</refname> <refpurpose>Clears window</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_wclear</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wcolor-set.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wcolor-set.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wcolor-set.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-wcolor-set.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-wcolor-set.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wcolor-set.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,38 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-wcolor-set"> <refnamediv> <refname>ncurses_wcolor_set</refname> <refpurpose>Sets windows color pairings</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_wcolor_set</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> <methodparam><type>int</type><parameter>color_pair</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>color_pair</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-werase.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-werase.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-werase.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-werase.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-werase.xml:1.3 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-werase.xml Mon Jan 15 23:41:55 2007 @@ -1,19 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-werase"> <refnamediv> <refname>ncurses_werase</refname> <refpurpose>Erase window contents</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_werase</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wgetch.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wgetch.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wgetch.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-wgetch.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-wgetch.xml:1.2 Mon Jan 15 18:54:00 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wgetch.xml Mon Jan 15 23:41:55 2007 @@ -1,19 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-wgetch"> <refnamediv> <refname>ncurses_wgetch</refname> <refpurpose>Reads a character from keyboard (window)</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_wgetch</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-whline.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-whline.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-whline.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-whline.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-whline.xml:1.2 Mon Jan 15 18:54:01 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-whline.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,46 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-whline"> <refnamediv> <refname>ncurses_whline</refname> <refpurpose>Draws a horizontal line in a window at current position using an attributed character and max. n characters long</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_whline</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> <methodparam><type>int</type><parameter>charattr</parameter></methodparam> <methodparam><type>int</type><parameter>n</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>charattr</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>n</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wmouse-trafo.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wmouse-trafo.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wmouse-trafo.xml:1.3 phpdoc/en/reference/ncurses/functions/ncurses-wmouse-trafo.xml:1.4 --- phpdoc/en/reference/ncurses/functions/ncurses-wmouse-trafo.xml:1.3 Mon Jan 15 18:54:01 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wmouse-trafo.xml Mon Jan 15 23:41:55 2007 @@ -1,13 +1,12 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.4 $ --> <refentry id="function.ncurses-wmouse-trafo"> <refnamediv> <refname>ncurses_wmouse_trafo</refname> <refpurpose>Transforms window/stdscr coordinates</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>ncurses_wmouse_trafo</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> @@ -15,8 +14,41 @@ <methodparam><type>int</type><parameter role="reference">x</parameter></methodparam> <methodparam><type>bool</type><parameter>toscreen</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>toscreen</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wmove.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wmove.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wmove.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-wmove.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-wmove.xml:1.2 Mon Jan 15 18:54:01 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wmove.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,46 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-wmove"> <refnamediv> <refname>ncurses_wmove</refname> <refpurpose>Moves windows output position</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_wmove</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> <methodparam><type>int</type><parameter>y</parameter></methodparam> <methodparam><type>int</type><parameter>x</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wnoutrefresh.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wnoutrefresh.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wnoutrefresh.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-wnoutrefresh.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-wnoutrefresh.xml:1.2 Mon Jan 15 18:54:01 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wnoutrefresh.xml Mon Jan 15 23:41:55 2007 @@ -1,19 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-wnoutrefresh"> <refnamediv> <refname>ncurses_wnoutrefresh</refname> <refpurpose>Copies window to virtual screen</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_wnoutrefresh</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wrefresh.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wrefresh.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wrefresh.xml:1.4 phpdoc/en/reference/ncurses/functions/ncurses-wrefresh.xml:1.5 --- phpdoc/en/reference/ncurses/functions/ncurses-wrefresh.xml:1.4 Mon Jan 15 18:54:01 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wrefresh.xml Mon Jan 15 23:41:55 2007 @@ -1,20 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.ncurses-wrefresh"> <refnamediv> <refname>ncurses_wrefresh</refname> <refpurpose>Refresh window on terminal screen </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_wrefresh</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> </methodsynopsis> - &warn.experimental.func; + &warn.experimental.func; + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wstandend.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wstandend.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wstandend.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-wstandend.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-wstandend.xml:1.2 Mon Jan 15 18:54:01 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wstandend.xml Mon Jan 15 23:41:55 2007 @@ -1,19 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-wstandend"> <refnamediv> <refname>ncurses_wstandend</refname> <refpurpose>End standout mode for a window</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_wstandend</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wstandout.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wstandout.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wstandout.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-wstandout.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-wstandout.xml:1.2 Mon Jan 15 18:54:01 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wstandout.xml Mon Jan 15 23:41:55 2007 @@ -1,19 +1,30 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-wstandout"> <refnamediv> <refname>ncurses_wstandout</refname> <refpurpose>Enter standout mode for a window</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_wstandout</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ncurses/functions/ncurses-wvline.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ncurses/functions/ncurses-wvline.xml diff -u phpdoc/en/reference/ncurses/functions/ncurses-wvline.xml:1.2 phpdoc/en/reference/ncurses/functions/ncurses-wvline.xml:1.3 --- phpdoc/en/reference/ncurses/functions/ncurses-wvline.xml:1.2 Mon Jan 15 18:54:01 2007 +++ phpdoc/en/reference/ncurses/functions/ncurses-wvline.xml Mon Jan 15 23:41:55 2007 @@ -1,21 +1,46 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> -<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> +<!-- $Revision: 1.3 $ --> <refentry id="function.ncurses-wvline"> <refnamediv> <refname>ncurses_wvline</refname> <refpurpose>Draws a vertical line in a window at current position using an attributed character and max. n characters long</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>ncurses_wvline</methodname> <methodparam><type>resource</type><parameter>window</parameter></methodparam> <methodparam><type>int</type><parameter>charattr</parameter></methodparam> <methodparam><type>int</type><parameter>n</parameter></methodparam> </methodsynopsis> + &warn.undocumented.func; + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - &warn.undocumented.func; + <variablelist> + <varlistentry> + <term><parameter>window</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>charattr</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>n</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> </refentry>
« previous php.doc (#969374823) next »