jimw Tue Jan 1 20:42:54 2002 EDT
Modified files:
/phpdoc/en/functions msession.xml
Log:
incorporate notes, use proper undocumented warnings
Index: phpdoc/en/functions/msession.xml
diff -u phpdoc/en/functions/msession.xml:1.3 phpdoc/en/functions/msession.xml:1.4
--- phpdoc/en/functions/msession.xml:1.3 Sat Dec 15 09:48:10 2001
+++ phpdoc/en/functions/msession.xml Tue Jan 1 20:42:54 2002
@@ -1,20 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<reference id="ref.msession">
<title>Mohawk Software session handler functions</title>
<titleabbrev>Msession functions</titleabbrev>
<partintro>
- <para>
- undocumented
- </para>
+ &warn.experimental;
</partintro>
-
<refentry id="function.msession-connect">
<refnamediv>
<refname>msession_connect</refname>
- <refpurpose>Connect to msession sever </refpurpose>
+ <refpurpose>Connect to msession server </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -25,9 +22,7 @@
<paramdef>string <parameter>port</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -44,9 +39,7 @@
<void/>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -63,9 +56,7 @@
<void/>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -82,9 +73,7 @@
<paramdef>string <parameter>session</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -101,9 +90,7 @@
<paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -120,9 +107,7 @@
<paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -140,9 +125,7 @@
<paramdef>int <parameter>key</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -161,9 +144,7 @@
<paramdef>string <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -182,9 +163,7 @@
<paramdef>string <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -201,9 +180,7 @@
<paramdef>int <parameter>param</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -220,9 +197,7 @@
<paramdef>int <parameter>param</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -240,9 +215,7 @@
<paramdef>string <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -259,9 +232,7 @@
<void/>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -278,9 +249,7 @@
<paramdef>string <parameter>session</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -298,16 +267,14 @@
<paramdef>array <parameter>tuples</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
<refentry id="function.msession-listvar">
<refnamediv>
<refname>msession_listvar</refname>
- <refpurpose>List variables in session </refpurpose>
+ <refpurpose>List sessions with variable</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -318,7 +285,11 @@
</funcprototype>
</funcsynopsis>
<para>
- undocumented
+ Returns an associative array of value, session for all sessions
+ with a variable named <parameter>name</parameter>.
+ </para>
+ <para>
+ Used for searching sessions with common attributes.
</para>
</refsect1>
</refentry>
@@ -339,9 +310,7 @@
</paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -359,9 +328,7 @@
<paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -378,9 +345,7 @@
<paramdef>string <parameter>session</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
@@ -398,16 +363,14 @@
<paramdef>string <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
<refentry id="function.msession-plugin">
<refnamediv>
<refname>msession_plugin</refname>
- <refpurpose>Register a session plugin ... ? </refpurpose>
+ <refpurpose>Call an escape function within the msession personality
+plugin</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@@ -421,14 +384,13 @@
</paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- undocumented
- </para>
+ &warn.undocumented.func;
</refsect1>
</refentry>
</reference>
+
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -445,5 +407,7 @@
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
-->
-
