mfischer Mon May 13 17:12:45 2002 EDT
Modified files:
/phpdoc/en/reference/misc/functions show-source.xml
Log:
- Remove documentation, everything is in highlight_file, no need to document
thigns twice but still leave the entry because it's very popular.
Index: phpdoc/en/reference/misc/functions/show-source.xml
diff -u phpdoc/en/reference/misc/functions/show-source.xml:1.2
phpdoc/en/reference/misc/functions/show-source.xml:1.3
--- phpdoc/en/reference/misc/functions/show-source.xml:1.2 Wed Apr 17 02:40:43
2002
+++ phpdoc/en/reference/misc/functions/show-source.xml Mon May 13 17:12:45 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/misc.xml, last change in rev 1.24 -->
<refentry id="function.show-source">
<refnamediv>
@@ -15,39 +15,11 @@
choice="opt"><type>bool</type><parameter>return</parameter></methodparam>
</methodsynopsis>
<simpara>
- The <function>show_source</function> function prints out a syntax
- higlighted version of the code contained in <parameter>filename</parameter>
- using the colors defined in the built-in syntax highlighter for PHP.
+ This function is an alias <function>highlight_file</function>. For more
+ informatin see the documentation there.
</simpara>
<simpara>
- If the second parameter <parameter>return</parameter> is set to &true;
- then <function>show_source</function> will return the highlighted
- code as a string instead of printing it out. If the second parameter is
- not set to &true; then <function>show_source</function> will
- return &true; on success, &false; on failure.
- </simpara>
- <note>
- <simpara>
- The <parameter>return</parameter> parameter became available in PHP
- 4.2.0. Before this time it behaved like the default, which is &false;
- </simpara>
- </note>
- <simpara>
- This function is an alias for the function
- <function>highlight_file</function>
- </simpara>
- <note>
- <simpara>
- Care should be taken when using the
- <function>show_source</function> and
- <function>highlight_file</function> functions to make sure that
- you do not inadvertently reveal sensitive information such as
- passwords or any other type of information that might create a
- potential security risk.
- </simpara>
- </note>
- <simpara>
- See also <function>highlight_string</function>,
+ See also <function>highlight_string</function> and
<function>highlight_file</function>.
</simpara>
</refsect1>
