Hannes,
Hopefully this patch will do it.
My plan on mysqli docs is just to fill in some of the current gaps.
Unfortunately, I don't have too much time available due to several other
projects that need my attention. I'll see what I can do though.
Thanks,
Tony
Hannes Magnusson wrote:
On Wed, Aug 20, 2008 at 13:21, Anthony Bedford <[EMAIL PROTECTED]> wrote:
Hi Hannes,
Ah thanks for that.
I've attached another diff (unified this time). Hopefully this will be a bit
more useable.
Replace "FALSE" with "&false;" and I think its perfect.
I'll push on with the existing templates for now, and if I get time later
have a look at helping out with creating some new templates.
OK.. But the "new templates" will only be useful for the mysqli
extension, as the current templates/skeletons fit perfectly for
regular prefix_funcname() <-> prefix::funcname() mapping.
Like I said before, mysqli randomly uses prefix_funcname() <->
prefix_suffix::funcname() or even prefix_suffix_funcname() <->
prefix::suffix_funcame() and various WTFs (which is the reason I
ignored the entire mysqli doc when I upgraded bunch of extensions
recently).
Personally, I would like to remove the current mysqli docs and start
from scratch to get the structure right and then copy&paste content
from the old files...
You've probably been asked this before - is there a whitespace
checking/formatting tool available?
At the bottom of each file are vim modelines which bunch of editors
support these days. Regarding "when to add \n".. I don't think we have
scripts to check that, its just something you get used to after
reading, and writing, couple of files :)
-Hannes
Index: attr-get.xml
===================================================================
RCS file: /repository/phpdoc/en/reference/mysqli/mysqli_stmt/attr-get.xml,v
retrieving revision 1.2
diff -u -r1.2 attr-get.xml
--- attr-get.xml 2 Jan 2008 14:27:37 -0000 1.2
+++ attr-get.xml 20 Aug 2008 12:38:00 -0000
@@ -1,24 +1,54 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
+
<refentry xml:id="mysqli-stmt.attr-get" xmlns="http://docbook.org/ns/docbook";>
<refnamediv>
<refname>mysqli_stmt::attr_get</refname>
<refname>mysqli_stmt_attr_get</refname>
- <refpurpose></refpurpose>
+ <refpurpose>Used to get the current value of a statement
attribute</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
+ <para>Object oriented style (method):</para>
+ <methodsynopsis>
+ <type>int</type><methodname>mysqli_stmt::attr_get</methodname>
+ <methodparam><type>int</type><parameter>attr</parameter></methodparam>
+ </methodsynopsis>
+ <para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>mysqli_stmt_attr_get</methodname>
<methodparam><type>mysqli_stmt</type><parameter>stmt</parameter></methodparam>
<methodparam><type>int</type><parameter>attr</parameter></methodparam>
</methodsynopsis>
+ <para>
+ Gets the current value of a statement attribute.
+ </para>
+ </refsect1>
- &warn.undocumented.func;
-
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ &mysqli.stmt.description;
+ <varlistentry>
+ <term><parameter>attr</parameter></term>
+ <listitem>
+ <para>
+ The attribute that you want to get.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
</refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns &false; if the attribute is not found, otherwise returns the value
of the attribute.
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
