Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:99592
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Received-SPF: pass (pb1.pair.com: domain gmail.com designates 209.85.223.181 as permitted sender)
MIME-Version: 1.0
In-Reply-To: <e982c2fa-e08c-0970-53d2-c0d6421c9573@fleshgrinder.com>
References: <e982c2fa-e08c-0970-53d2-c0d6421c9573@fleshgrinder.com>
Date: Wed, 21 Jun 2017 17:38:20 +0200
Message-ID: <CAF+90c-9uSA+ykCWg_+pSRdZpJcLoScHawK8MWVGGjCx+dA59g@mail.gmail.com>
To: Fleshgrinder <php@fleshgrinder.com>
Cc: php-internals <internals@lists.php.net>
Content-Type: multipart/alternative; boundary="001a113ee16a689c7405527a28ce"
Subject: Re: [PHP-DEV] [RFC] [Vote] Doxygen
From: nikita.ppv@gmail.com (Nikita Popov)

--001a113ee16a689c7405527a28ce
Content-Type: text/plain; charset="UTF-8"

On Sat, Jun 17, 2017 at 9:53 AM, Fleshgrinder <php@fleshgrinder.com> wrote:

> Hi!
>
> I started voting on the Doxygen RFC:
>
> https://wiki.php.net/rfc/doxygen
>
> --
> Richard "Fleshgrinder" Fussenegge
>

Can you please clarify where functions that are declared in a header and
defined in a source file should be documented? I believe the usual
recommendation is to document in the source file, because it's closer to
the implementation and thus more likely to be updated. On the other hand,
documentation in headers only is more useful if you're just browsing code
and not using generated output.

Nikita

--001a113ee16a689c7405527a28ce--