Newsgroups: php.internals Path: news.php.net Xref: news.php.net php.internals:99281 Return-Path: Mailing-List: contact internals-help@lists.php.net; run by ezmlm Delivered-To: mailing list internals@lists.php.net Received: (qmail 73379 invoked from network); 30 May 2017 19:32:31 -0000 Received: from unknown (HELO lists.php.net) (127.0.0.1) by localhost with SMTP; 30 May 2017 19:32:31 -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 77.244.243.82 cause and error) X-PHP-List-Original-Sender: php@fleshgrinder.com X-Host-Fingerprint: 77.244.243.82 mx101.easyname.com Received: from [77.244.243.82] ([77.244.243.82:47332] helo=mx101.easyname.com) by pb1.pair.com (ecelerity 2.1.1.9-wez r(12769M)) with ESMTP id 4E/15-43873-DC8CD295 for ; Tue, 30 May 2017 15:32:31 -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.84_2) (envelope-from ) id 1dFmsT-0002b6-8a; Tue, 30 May 2017 19:32:26 +0000 References: <5fca5c60-828d-5fb4-8ef8-74d69036e8f8@gmail.com> <5d5fe894-7ef7-23c5-cba1-4cb7a305207f@fleshgrinder.com> To: php-internals , Stanislav Malyshev Message-ID: Date: Tue, 30 May 2017 21:32:20 +0200 User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.1.1 MIME-Version: 1.0 In-Reply-To: Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="ANkRaGEQginnq6OWO69DM5hafuUMaC6px" X-DNSBL-PBLSPAMHAUS: YES Subject: Re: [PHP-DEV] Documentation (Doxygen) From: php@fleshgrinder.com (Fleshgrinder) --ANkRaGEQginnq6OWO69DM5hafuUMaC6px Content-Type: multipart/mixed; boundary="IEd4CqcQNNqjPEr15qdT1HKTdMRpvQhF5"; protected-headers="v1" From: Fleshgrinder To: php-internals , Stanislav Malyshev Message-ID: Subject: Re: [PHP-DEV] Documentation (Doxygen) References: <5fca5c60-828d-5fb4-8ef8-74d69036e8f8@gmail.com> <5d5fe894-7ef7-23c5-cba1-4cb7a305207f@fleshgrinder.com> In-Reply-To: --IEd4CqcQNNqjPEr15qdT1HKTdMRpvQhF5 Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: quoted-printable On 5/30/2017 9:26 PM, Stanislav Malyshev wrote: > Hi! >=20 > Sorry if it sounded that way, I of course meant nothing like it. I just= > meant that introducing docs standard should not be made in a routine > unrelated patch, where it could be missed by many people, but as an > ordered process. Otherwise, you'd introduce Doxygen, somebody unaware o= f > it would introduce another thing, and pretty soon we have code > documented in a dozen of incompatible ways and it's a mess. I certainly= > did not imply any malice on your part, just that we need to do it in an= > explicit way that informs everybody what it happening. >=20 >> used to properly documenting my code, as it is part of any professiona= l >> code base in my opinion. >=20 > Surely, and it's without doubt a good thing. We just need to do it > right, otherwise we'd have to spend more time later to fix it. It > requires a bit of time, but better spend it now than end up with code > documented in a way that no doc system would be able to parse, IMO. >=20 No offense taken. :) I totally agree with you in all of this. Writing an RFC for every tiny thing is a lot of work, but it is the correct way of doing things, so I'll sit down and do exactly that. --=20 Richard "Fleshgrinder" Fussenegger --IEd4CqcQNNqjPEr15qdT1HKTdMRpvQhF5-- --ANkRaGEQginnq6OWO69DM5hafuUMaC6px 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 iQIcBAEBCAAGBQJZLcjEAAoJEOKkKcqFPVVrM9EP/iwLnaUkgePgEE+klnTmYJ1I hCGbMGZ85vhmwsLcC5NaiPGYCw1NX1o9IRJmWwIOmSwXxD7b5C6ypzLHNSMZPTq5 tvSaLptR8FwzFztPJZb9e1sBAzbqAuP8WQtFbL3svuvbjK5MGVKOsskAIQyJQXFh 4W3qumhm2V9arVLA+Oc49lB98TsTgFo5qeuZJpVe/E+2J1cKefPwOegOFvyOCE1w qWV95IEOphSwIO3JfUyA9i2wTzqupC4jwBgFrhBWuxQcy2aGhdl5vpxHW1nL5YQw zcNxCB6ic3k46/0qi6idpnFO6hFEXAIfs7M5HMOYHhpEWGGVmmvUzNweQTPlHomL znmcS1Mt1te779eXZMmC3Z40HtNxK7SFNOgx1Y6UXDSVmgVHk3vU/9VvbKykQJeP istGA9VWI48Mx8LhP2DI1cIh1unvzWo+dMekgUhZiX22AaBDVD6qMyhRin77+yCN YvFDilIrBbANhonve5cDOdpS+e7ikAdFQG9bgadlBIl4JQGn3w2O3h3DGiexD3YV D0WNeIBuwPFW3e1f5z+eCnOhF6qxtJ5EjS7pkmp5UtpVqRhd0NMDSBF/IE1uYC2D /HfHYyUqGEbB3pGSsTaPYzh937eyB5JBqzHYhnQDbBvgun3ClNkFr/ch8Q/d5gJS S+xKsjHWHSaITCVOczOn =X8ge -----END PGP SIGNATURE----- --ANkRaGEQginnq6OWO69DM5hafuUMaC6px--