<initializer>

From: Date: Thu, 19 Jun 2003 17:24:10 +0000
Subject: <initializer>
Groups: php.doc 
Request: Send a blank email to phpdoc+get-969354626@lists.php.net to get a copy of this message
DocBook 4 has an <initializer> tag that may be used to add default values to a <methodparam> function parameter A parameter that has a default / initializer value is now considered optional and the default value is shown in italics. Example: <methodsynopsis> <void/> <methodname>Ask</methodname> <methodparam> <type>string</type> <parameter>query_str</parameter> </methodparam> <methodparam> <type>bool</type> <parameter>single_step</parameter> <initializer>false</initializer> </methodparam> </methodsynopsis> is now rendered as void Ask (string query_str [, bool single_step=false]) without the changes it was void Ask (string query_str, bool single_stepfalse) without []s, = and with false in red (DSSSL) or wouldn't render at all (XSLT) TODO: i didn't touch the FO/print stuff yet,
      so in XSL/print builds the default value won't be
      italics ...
-- 
Hartmut Holzgraefe  <hartmut@php.net>



« previous php.doc (#969354626) next »