Added & to error_message methodsynopsis (it's passed in by reference)

Compared use to php -l, and added some links and <parameter> tags.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@164034 c90b9560-bf6c-de11-be94-00142212c4b1

reference/misc/functions/php-check-syntax.xml

@@ -1,10 +1,10 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <refentry id="function.php-check-syntax">
  <refnamediv>
   <refname>php_check_syntax</refname>
   <refpurpose>
-   Check the syntax of the specified file
+   Check the PHP syntax of the specified file
   </refpurpose>
  </refnamediv>
  <refsect1>
@@ -12,16 +12,19 @@
   <methodsynopsis>
    <type>bool</type><methodname>php_check_syntax</methodname>
    <methodparam><type>string</type><parameter>file_name</parameter></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>error_message</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>&amp;error_message</parameter></methodparam>
   </methodsynopsis>
     <simpara>
      The <function>php_check_syntax</function> function performs a syntax 
      (lint) check on the specified <parameter>filename</parameter> testing
-     for scripting errors.
+     for scripting errors.  This is similar to using <literal>php -l</literal>
+     from the <link linkend="features.commandline">commandline</link>.
     </simpara>
     <simpara>
-     If the second parameter is passed, it will contain the error message
-     from the syntax check. This parameter must be passed by reference.
+     If the <parameter>error_message</parameter> parameter is used, it will
+     contain the error message from the syntax check. <parameter>error_message
+     </parameter> must be passed in by <link linkend="language.references"> 
+     reference</link>.
     </simpara>
     <para>
      The following example shows how this function can be used.