cvs: peardoc /en/package/filesystem/file-passwd/file-passwd factory.xml /en/package/filesystem/file-passwd/file-passwd-authbasic
file_passwd_authbasic.xml /en/package/filesystem/file-passwd/file-passwd-authdigest file_passwd_authdigest.xml
/en/package/filesystem/file-passwd/file-passwd-cvs file_passwd_cvs.xml /en/package/filesystem/file-passwd/file-passwd-smb file_passwd_smb.xml
/en/package/filesystem/file-passwd/file-passwd-unix file_passwd_unix.xml

mike Mon Oct 13 12:36:57 2003 EDT Modified files: /peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic file_passwd_authbasic.xml /peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest file_passwd_authdigest.xml /peardoc/en/package/filesystem/file-passwd/file-passwd-cvs file_passwd_cvs.xml /peardoc/en/package/filesystem/file-passwd/file-passwd-smb file_passwd_smb.xml /peardoc/en/package/filesystem/file-passwd/file-passwd-unix file_passwd_unix.xml /peardoc/en/package/filesystem/file-passwd/file-passwd factory.xml Log: some fixes concerning synopsis and return values Index: peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic/file_passwd_authbasic.xml diff -u peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic/file_passwd_authbasic.xml:1.1 peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic/file_passwd_authbasic.xml:1.2 --- peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic/file_passwd_authbasic.xml:1.1 Fri Oct 10 12:34:18 2003 +++ peardoc/en/package/filesystem/file-passwd/file-passwd-authbasic/file_passwd_authbasic.xml Mon Oct 13 12:36:53 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic"> <refnamediv> @@ -13,8 +13,7 @@ </funcsynopsisinfo> <funcprototype> <funcdef> - object - <function>File_Passwd_Authbasic::File_Passwd_Authbasic</function> + object &amp;new <function>File_Passwd_Authbasic</function> </funcdef> <paramdef>string <parameter> <optional>$file = '.htpasswd'</optional></parameter></paramdef> </funcprototype> @@ -44,6 +43,13 @@ </listitem> </varlistentry> </variablelist> + </para> + </refsect1> + + <refsect1 id="package.filesystem.file-passwd.file-passwd-authbasic.file-passwd-authbasic.return"> + &title.returns; + <para> + Returns &type.object; <classname>File_Passwd_Authbasic</classname>. </para> </refsect1> Index: peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest/file_passwd_authdigest.xml diff -u peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest/file_passwd_authdigest.xml:1.1 peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest/file_passwd_authdigest.xml:1.2 --- peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest/file_passwd_authdigest.xml:1.1 Fri Oct 10 12:34:19 2003 +++ peardoc/en/package/filesystem/file-passwd/file-passwd-authdigest/file_passwd_authdigest.xml Mon Oct 13 12:36:53 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest"> <refnamediv> <refname><function>File_Passwd_Authdigest::File_Passwd_Authdigest</function></refname> @@ -11,7 +11,7 @@ require_once 'Passwd/Authdigest.php'; </funcsynopsisinfo> <funcprototype> - <funcdef>object <function>File_Passwd_Authdigest::File_Passwd_Authdigest</function></funcdef> + <funcdef>object &amp;new <function>File_Passwd_Authdigest</function></funcdef> <paramdef>string <parameter><optional>$file = '.htdigest'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> @@ -46,7 +46,7 @@ <refsect1 id="package.filesystem.file-passwd.file-passwd-authdigest.file-passwd-authdigest.return"> &title.returns; <para> - Returns object - a new File_Passwd_Authdigest object. + Returns &type.object; <classname>File_Passwd_Authdigest</classname>. </para> </refsect1> Index: peardoc/en/package/filesystem/file-passwd/file-passwd-cvs/file_passwd_cvs.xml diff -u peardoc/en/package/filesystem/file-passwd/file-passwd-cvs/file_passwd_cvs.xml:1.1 peardoc/en/package/filesystem/file-passwd/file-passwd-cvs/file_passwd_cvs.xml:1.2 --- peardoc/en/package/filesystem/file-passwd/file-passwd-cvs/file_passwd_cvs.xml:1.1 Fri Oct 10 12:34:21 2003 +++ peardoc/en/package/filesystem/file-passwd/file-passwd-cvs/file_passwd_cvs.xml Mon Oct 13 12:36:54 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-cvs.file-passwd-cvs"> <refnamediv> @@ -8,9 +8,7 @@ <refsynopsisdiv> <funcsynopsis> - <funcsynopsisinfo> - require_once 'File/Passwd/Cvs.php'; - </funcsynopsisinfo> + <funcsynopsisinfo>require_once 'File/Passwd/Cvs.php';</funcsynopsisinfo> <funcprototype> <funcdef>object &amp;new <function>File_Passwd_Cvs</function></funcdef> <paramdef>mixed <parameter><optional>$file = 'passwd'</optional></parameter></paramdef> Index: peardoc/en/package/filesystem/file-passwd/file-passwd-smb/file_passwd_smb.xml diff -u peardoc/en/package/filesystem/file-passwd/file-passwd-smb/file_passwd_smb.xml:1.1 peardoc/en/package/filesystem/file-passwd/file-passwd-smb/file_passwd_smb.xml:1.2 --- peardoc/en/package/filesystem/file-passwd/file-passwd-smb/file_passwd_smb.xml:1.1 Fri Oct 10 12:34:22 2003 +++ peardoc/en/package/filesystem/file-passwd/file-passwd-smb/file_passwd_smb.xml Mon Oct 13 12:36:55 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-smb.file-passwd-smb"> <refnamediv> @@ -8,9 +8,7 @@ <refsynopsisdiv> <funcsynopsis> - <funcsynopsisinfo> - require_once 'File/Passwd/Smb.php'; - </funcsynopsisinfo> + <funcsynopsisinfo>require_once 'File/Passwd/Smb.php';</funcsynopsisinfo> <funcprototype> <funcdef>object &amp;new <function>File_Passwd_Smb</function></funcdef> <paramdef>string <parameter> <optional>$file = 'smbpasswd'</optional></parameter></paramdef> Index: peardoc/en/package/filesystem/file-passwd/file-passwd-unix/file_passwd_unix.xml diff -u peardoc/en/package/filesystem/file-passwd/file-passwd-unix/file_passwd_unix.xml:1.1 peardoc/en/package/filesystem/file-passwd/file-passwd-unix/file_passwd_unix.xml:1.2 --- peardoc/en/package/filesystem/file-passwd/file-passwd-unix/file_passwd_unix.xml:1.1 Fri Oct 10 12:34:23 2003 +++ peardoc/en/package/filesystem/file-passwd/file-passwd-unix/file_passwd_unix.xml Mon Oct 13 12:36:56 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix"> <refnamediv> @@ -8,11 +8,9 @@ <refsynopsisdiv> <funcsynopsis> - <funcsynopsisinfo> - require_once 'File/Passwd/Unix.php'; - </funcsynopsisinfo> + <funcsynopsisinfo>require_once 'File/Passwd/Unix.php';</funcsynopsisinfo> <funcprototype> - <funcdef>object &amp;new <function>File_Passwd_Unix::File_Passwd_Unix</function></funcdef> + <funcdef>object &amp;new <function>File_Passwd_Unix</function></funcdef> <paramdef>string <parameter><optional>$file = 'passwd'</optional></parameter></paramdef> </funcprototype> </funcsynopsis> @@ -50,6 +48,7 @@ Returns &type.object; <classname>File_Passwd_Unix</classname>. </para> </refsect1> + <refsect1 id="package.filesystem.file-passwd.file-passwd-unix.file-passwd-unix.throws"> &title.throws; <para> Index: peardoc/en/package/filesystem/file-passwd/file-passwd/factory.xml diff -u peardoc/en/package/filesystem/file-passwd/file-passwd/factory.xml:1.1 peardoc/en/package/filesystem/file-passwd/file-passwd/factory.xml:1.2 --- peardoc/en/package/filesystem/file-passwd/file-passwd/factory.xml:1.1 Fri Oct 10 12:34:25 2003 +++ peardoc/en/package/filesystem/file-passwd/file-passwd/factory.xml Mon Oct 13 12:36:57 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.filesystem.file-passwd.file-passwd.factory"> <refnamediv> @@ -8,13 +8,10 @@ <refsynopsisdiv> <funcsynopsis> - <funcsynopsisinfo> - require_once 'File/Passwd.php'; - </funcsynopsisinfo> + <funcsynopsisinfo>require_once 'File/Passwd.php';</funcsynopsisinfo> <funcprototype> <funcdef> - object - &amp;<function>File_Passwd::factory</function> + object &amp;<function>File_Passwd::factory</function> </funcdef> <paramdef>string <parameter>$class</parameter></paramdef> </funcprototype> @@ -69,7 +66,7 @@ <refsect1 id="package.filesystem.file-passwd.file-passwd.factory.return"> &title.returns; <para> - &return.success-pearerror; + Returns &type.object; <classname>File_Passwd</classname> extension or <classname>PEAR_Error</classname> on failure. </para> </refsect1>