Newsgroups: php.internals Path: news.php.net Xref: news.php.net php.internals:99590 Return-Path: Mailing-List: contact internals-help@lists.php.net; run by ezmlm Delivered-To: mailing list internals@lists.php.net Received: (qmail 82147 invoked from network); 21 Jun 2017 14:45:20 -0000 Received: from unknown (HELO lists.php.net) (127.0.0.1) by localhost with SMTP; 21 Jun 2017 14:45:20 -0000 Authentication-Results: pb1.pair.com smtp.mail=php@fleshgrinder.com; spf=permerror; sender-id=unknown Authentication-Results: pb1.pair.com header.from=php@fleshgrinder.com; sender-id=unknown Received-SPF: error (pb1.pair.com: domain fleshgrinder.com from 212.232.25.162 cause and error) X-PHP-List-Original-Sender: php@fleshgrinder.com X-Host-Fingerprint: 212.232.25.162 mx206.easyname.com Received: from [212.232.25.162] ([212.232.25.162:33572] helo=mx206.easyname.com) by pb1.pair.com (ecelerity 2.1.1.9-wez r(12769M)) with ESMTP id 41/2C-13828-C768A495 for ; Wed, 21 Jun 2017 10:45:18 -0400 Received: from cable-81-173-132-37.netcologne.de ([81.173.132.37] helo=[192.168.178.20]) by mx.easyname.com with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.89) (envelope-from ) id 1dNgsW-00057P-7P; Wed, 21 Jun 2017 14:45:13 +0000 References: To: php-internals , Jakub Zelenka Message-ID: <584f9034-6ac3-a21c-d557-43f8ac780d88@fleshgrinder.com> Date: Wed, 21 Jun 2017 16:44:49 +0200 User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.2.0 MIME-Version: 1.0 In-Reply-To: Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="BcxBQFHUtl99cNj0KsbW7bsBEEWs5J2j4" X-DNSBL-PBLSPAMHAUS: YES Subject: Re: [PHP-DEV] [RFC] [Vote] Doxygen From: php@fleshgrinder.com (Fleshgrinder) --BcxBQFHUtl99cNj0KsbW7bsBEEWs5J2j4 Content-Type: multipart/mixed; boundary="EXgSTBtvietiAVsb0tr3qObvA5l9iv3mn"; protected-headers="v1" From: Fleshgrinder To: php-internals , Jakub Zelenka Message-ID: <584f9034-6ac3-a21c-d557-43f8ac780d88@fleshgrinder.com> Subject: Re: [PHP-DEV] [RFC] [Vote] Doxygen References: In-Reply-To: --EXgSTBtvietiAVsb0tr3qObvA5l9iv3mn Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: quoted-printable On 6/19/2017 2:31 PM, Jakub Zelenka wrote: > On Sat, Jun 17, 2017 at 8:53 AM, Fleshgrinder wr= ote: >=20 >> Hi! >> >> I started voting on the Doxygen RFC: >> >> https://wiki.php.net/rfc/doxygen >> >> > I just wanted to send my feedback and the reason why I voted "yes". Fir= st > of all I don't really like adding too much documentation to the code (I= 'm > actually talking about the PR which seems really too much IMHO). Howeve= r I > think that this RFC is more about having a standard for documenting > exported functions which would be really good in my opinion and I think= > Doxygen is really good one (one can easily see that in Apache httpd for= > example). I think that few lines is usually enough and sometimes it is > useful to have a note about the used parameters. What I want to say is = that > we shouldn't think about the RFC as accepting the proposed PR. It shoul= d be > treated on case by case bases and over documented code should be still > rejected. >=20 > Cheers >=20 > Jakub >=20 Thanks for the feedback, the intend of this RFC is exactly as you understood it. It's not a +1 for the linked PR. As I said to Nikic, whether a particular PR is acceptable or not must be part of a code revie= w. --=20 Richard "Fleshgrinder" Fussenegger --EXgSTBtvietiAVsb0tr3qObvA5l9iv3mn-- --BcxBQFHUtl99cNj0KsbW7bsBEEWs5J2j4 Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 iQIcBAEBCAAGBQJZSoZoAAoJEOKkKcqFPVVrV9cP/0eNwVJ5zCVZi06Ra/GW5iiB QvIXXYbIRHoOnADLMJf/bK1q82LFZGjxvssJ7WShk+72bSzd6CBODt5W4OIb3Tcp Z6Pc1Nvgo8tAEAT2BtRh50AWSbS+0kJY8GTOzpwO92JaAH+VkBVVSHOk+Foxa7zK Y4QNeq/d832RBEz+77uHaRF56hPzrezLnsqLsLekbjZADab3xMQeZnT6lFPit3Wf Yy/M5suMYaCN0TcUIMEnokmy4OSyHp8SqEmoHJdQCLeP6ZwyHUtslMXjZtrUHal7 GXp5fzeaXbfnZP62uxgyRUzfmnekQTE3GW2vnaPZoKMWB5lz5Z/EQCPgEUlEsCex fGl4JCXNHrqO68saVceMrjQ7gwxDxEGXBdXtZ2PPvFJbVpHFIzqScJSj+GeGf6VM NTjehyePOtuJaXaHTT7x0QgPtl+LQrwzMv6hyBObwWBOOqqhYmmdYgZ3E9DixRkP OTml7qrjveeZNnHQS5vkSxMebdt+Gil74Rxav85Wu6+pmtCBzJt53s5oJMxAzjJQ dS+UFi0O+ZkIkKVbwYEa/nN8p58SwqtWOYhjALdeNg7Jl1q7DUdBQNo9WX8ZU7f2 9b+ZExaAdAuX8es2NwYSvpAAOc6hS/RdpgTaJ4NzqymKMsBnoAkzvMLklYI4v1AR lIDP7MuVDcWorfzlTLji =qsDy -----END PGP SIGNATURE----- --BcxBQFHUtl99cNj0KsbW7bsBEEWs5J2j4--