You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Garrett Rooney <ro...@electricjellyfish.net> on 2006/04/15 00:37:24 UTC
Re: svn commit: r19383 - trunk/subversion/libsvn_ra_serf
On 4/14/06, jerenkrantz@tigris.org <je...@tigris.org> wrote:
> /*
> - * Handler that discards the entire request body.
> + * Handler that discards the entire @a response body associated with a
> + * @a request.
@a type markup only has real meaning in a doxygen comment, meaning it
needs to start with /**, which these do not. This happens in a bunch
of other places in this commit as well.
-garrett
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: svn commit: r19383 - trunk/subversion/libsvn_ra_serf
Posted by Garrett Rooney <ro...@electricjellyfish.net>.
On 4/14/06, Justin Erenkrantz <ju...@erenkrantz.com> wrote:
> On 4/14/06, Garrett Rooney <ro...@electricjellyfish.net> wrote:
> > @a type markup only has real meaning in a doxygen comment, meaning it
> > needs to start with /**, which these do not. This happens in a bunch
> > of other places in this commit as well.
>
> So...I believe I did it that way with the ** before with my
> Doxygen-style comments and Peter kept saying I was doing it wrong and
> he eventually reverted all of the **'s. *shrug*
That might be because we don't generally use doxygen style comments on
internal headers.
-garrett
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: svn commit: r19383 - trunk/subversion/libsvn_ra_serf
Posted by Max Bowsher <ma...@ukf.net>.
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Justin Erenkrantz wrote:
> On 4/16/06, Peter N. Lundblad <pe...@famlundblad.se> wrote:
>> No doxygen for internal code. There, we use the GNU style.
>
> It seems like we're using doxygen in some other places internally.
> HACKING says that doxygen is preferred and that GNU style is for older
> doc styles - not just internal.
That sentence of hacking.html immediately follows one that specifically
talks about 'interface documentation' - i.e. it is specifically talking
about public interfaces only/
> I'd personally prefer doxygen (aka JavaDoc) over GNU style. We should
> be able to auto-generate our docs for internal interfaces too. We
> can't really do that with GNU style docco... -- justin
Why would we want autogenerated separate documentation for intralibrary
functions? Such documentation only needs to get read by people actually
looking at the code itself, so simply embedding it in the code and
optimizing for readability in a text editor seems a reasonable thing to
do to me.
Max.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2.1 (Cygwin)
iD8DBQFER09zfFNSmcDyxYARAlhZAKC/JU8a2NvR1zwlFT09po6Mb5T59ACgmhnB
uos668oyl3TOzn+tOzeQbFw=
=d1iv
-----END PGP SIGNATURE-----
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: svn commit: r19383 - trunk/subversion/libsvn_ra_serf
Posted by Justin Erenkrantz <ju...@erenkrantz.com>.
On 4/16/06, Peter N. Lundblad <pe...@famlundblad.se> wrote:
> No doxygen for internal code. There, we use the GNU style.
It seems like we're using doxygen in some other places internally.
HACKING says that doxygen is preferred and that GNU style is for older
doc styles - not just internal.
I'd personally prefer doxygen (aka JavaDoc) over GNU style. We should
be able to auto-generate our docs for internal interfaces too. We
can't really do that with GNU style docco... -- justin
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: svn commit: r19383 - trunk/subversion/libsvn_ra_serf
Posted by "Peter N. Lundblad" <pe...@famlundblad.se>.
Justin Erenkrantz writes:
> On 4/14/06, Garrett Rooney <ro...@electricjellyfish.net> wrote:
> > @a type markup only has real meaning in a doxygen comment, meaning it
> > needs to start with /**, which these do not. This happens in a bunch
> > of other places in this commit as well.
>
> So...I believe I did it that way with the ** before with my
> Doxygen-style comments and Peter kept saying I was doing it wrong and
> he eventually reverted all of the **'s. *shrug* -- justin
>
No doxygen for internal code. There, we use the GNU style.
Regards,
//Peter
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: svn commit: r19383 - trunk/subversion/libsvn_ra_serf
Posted by Justin Erenkrantz <ju...@erenkrantz.com>.
On 4/14/06, Garrett Rooney <ro...@electricjellyfish.net> wrote:
> @a type markup only has real meaning in a doxygen comment, meaning it
> needs to start with /**, which these do not. This happens in a bunch
> of other places in this commit as well.
So...I believe I did it that way with the ** before with my
Doxygen-style comments and Peter kept saying I was doing it wrong and
he eventually reverted all of the **'s. *shrug* -- justin
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org