File: setDebug.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (95 lines) | stat: -rw-r--r-- 2,287 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 322205 $ -->
<refentry xml:id='samconnection.setdebug' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>SAMConnection::setDebug</refname>
  <refpurpose>
   Turn on or off additional debugging output.
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
  The "setdebug" method is used to turn on or off additional debugging output. The SAM framework will provide method/function
  entry and exit trace data plus additional information. Protocol specific implementations also provide extra output.
  </para>
  <methodsynopsis>
   <type>void</type><methodname>SAMConnection::setDebug</methodname>
   <methodparam><type>bool</type><parameter>switch</parameter></methodparam>
  </methodsynopsis>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>switch</parameter></term>
     <listitem>
      <para>
        If this parameter is set to &true; additional debugging output will be provided. If the value is set to &false; output
        of additional information will be stopped.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Turn on debugging output</title>
    <programlisting role="php">
<![CDATA[
<?php
$conn->setdebug(TRUE);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Turn off debugging output</title>
    <programlisting role="php">
<![CDATA[
<?php
$conn->setdebug(FALSE);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
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
-->