Req #75527 [Com]: Foreign return type syntax

From: Date: Tue, 14 Nov 2017 20:56:39 +0000
Subject: Req #75527 [Com]: Foreign return type syntax
References: 1  Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-15238@lists.php.net to get a copy of this message
Edit report at https://bugs.php.net/bug.php?id=75527&edit=1 ID: 75527 Comment by: jonathan at jjok dot co dot uk Reported by: jonathan at jjok dot co dot uk Summary: Foreign return type syntax Status: Open Type: Feature/Change Request Package: Doc Build problem PHP Version: Irrelevant Block user comment: N Private report: N New Comment: I've been having a look into this. I think a few changes will need to be made to make this happen. 1. I think a new returntype needs to be added in the formatter classes in this package. eg Package_Generic_XHTML. I don't think type can be reused as it is used anywhere a type is mentioned in the docs, not just return types, and the return type needs to be formatted differently. eg sprintf(' : <span>%s</span>') 2. I think the docbook schema in the phpdoc repository needs to be updated to allow a new returntype element. ``` <methodsynopsis> <methodname>json_decode</methodname> <methodparam><type>string</type><parameter>json</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>assoc</parameter><initializer>false</initializer></methodparam> <methodparam choice="opt"><type>int</type><parameter>depth</parameter><initializer>512</initializer></methodparam> <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam> <returntype>mixed</returntype> </methodsynopsis> ``` 3. All the existing documentation needs to be updated to the new format. :O Let me know if I'm on the right tracks. Thanks. Previous Comments: ------------------------------------------------------------------------ [2017-11-14 20:54:59] jonathan at jjok dot co dot uk Description: ------------ I noticed that the documentation still uses Java/C# style return types, even though PHP now has its own syntax for return types. For exmaple: ``` mixed json_decode ( string $json ) ``` instead of: ``` json_decode ( string $json ) : mixed ``` It would be nice to see the documentation reflect the syntax of the language. ------------------------------------------------------------------------ -- Edit this bug report at https://bugs.php.net/bug.php?id=75527&edit=1

« previous php.doc.bugs (#15238) next »