Re: [RFC] [Vote] Doxygen
| From: | Jakub Zelenka | Date: | Mon, 19 Jun 2017 12:31:06 +0000 |
| Subject: | Re: [RFC] [Vote] Doxygen | ||
| References: | 1 | Groups: | php.internals |
| Request: | Send a blank email to internals+get-99544@lists.php.net to get a copy of this message | ||
On Sat, Jun 17, 2017 at 8:53 AM, Fleshgrinder <php@fleshgrinder.com> wrote:
> 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". First
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). However 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 should be
treated on case by case bases and over documented code should be still
rejected.
Cheers
Jakub