You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Hyrum K Wright <hy...@wandisco.com> on 2011/09/22 08:49:17 UTC
Re: svn commit: r1173935 - /subversion/trunk/subversion/include/private/svn_subr_private.h
On Thu, Sep 22, 2011 at 3:31 AM, <da...@apache.org> wrote:
> Author: danielsh
> Date: Thu Sep 22 02:31:06 2011
> New Revision: 1173935
>
> URL: http://svn.apache.org/viewvc?rev=1173935&view=rev
> Log:
> * subversion/include/private/svn_subr_private.h: Doxygen markup fixes.
You probably already know this, but stuff in include/private doesn't
get processed by doxygen (and this comment wouldn't anyway, since it
doesn't lead with a '/**' ).
-Hyrum
>
> Modified:
> subversion/trunk/subversion/include/private/svn_subr_private.h
>
> Modified: subversion/trunk/subversion/include/private/svn_subr_private.h
> URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/private/svn_subr_private.h?rev=1173935&r1=1173934&r2=1173935&view=diff
> ==============================================================================
> --- subversion/trunk/subversion/include/private/svn_subr_private.h (original)
> +++ subversion/trunk/subversion/include/private/svn_subr_private.h Thu Sep 22 02:31:06 2011
> @@ -113,8 +113,8 @@ svn_spillbuf__write(svn_spillbuf_t *buf,
> apr_pool_t *scratch_pool);
>
>
> -/* Read a block of memory from the spill buffer. @a data will be set to
> - NULL if no content remains. Otherwise, @data and @len will point to
> +/* Read a block of memory from the spill buffer. @a *data will be set to
> + NULL if no content remains. Otherwise, @a data and @a len will point to
> data that must be fully-consumed by the caller. This data will remain
> valid until another call to svn_spillbuf_write(), svn_spillbuf_read(),
> or svn_spillbuf_process(), or if the spill buffer's pool is cleared. */
> @@ -187,7 +187,7 @@ svn_spillbuf__reader_getc(char *c,
> apr_pool_t *scratch_pool);
>
>
> -/* Write @a len bytes from @a data into the spill-buffer in @reader. */
> +/* Write @a len bytes from @a data into the spill-buffer in @a reader. */
> svn_error_t *
> svn_spillbuf__reader_write(svn_spillbuf_reader_t *reader,
> const char *data,
>
>
>
--
uberSVN: Apache Subversion Made Easy
http://www.uberSVN.com/
Re: svn commit: r1173935 -
/subversion/trunk/subversion/include/private/svn_subr_private.h
Posted by Daniel Shahaf <da...@elego.de>.
Hyrum K Wright wrote on Thu, Sep 22, 2011 at 07:49:17 +0100:
> On Thu, Sep 22, 2011 at 3:31 AM, <da...@apache.org> wrote:
> > Author: danielsh
> > Date: Thu Sep 22 02:31:06 2011
> > New Revision: 1173935
> >
> > URL: http://svn.apache.org/viewvc?rev=1173935&view=rev
> > Log:
> > * subversion/include/private/svn_subr_private.h: Doxygen markup fixes.
>
> You probably already know this, but stuff in include/private doesn't
> get processed by doxygen (and this comment wouldn't anyway, since it
> doesn't lead with a '/**' ).
>
True, but the comments do use doxygen syntax.
> > -/* Write @a len bytes from @a data into the spill-buffer in @reader. */
Re: svn commit: r1173935 -
/subversion/trunk/subversion/include/private/svn_subr_private.h
Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Greg Stein wrote on Thu, Sep 22, 2011 at 14:25:59 -0400:
> On Thu, Sep 22, 2011 at 13:55, Daniel Shahaf <d....@daniel.shahaf.name> wrote:
> > Greg Stein wrote on Thu, Sep 22, 2011 at 13:33:37 -0400:
> >...
> >> Can we get the nightly to do it? ie. for devs rather than part of official
> >> released API doc?
> >
> > This would require someone to convert all the docs in
> > subversion/include/private/ to the doxygen format. I think between OCD
> > and scripting abilities someone can make the conversion. (if we want to
> > do it)
>
> Good point.
>
> *shrug*
>
> I just kinda used doxygen as a default. I doubt that we'd want to
> expose the spillbuf interface because it probably won't be used in any
> of our public APIs, and it doesn't directly relate to Subversion.
>
Agreed, but, as you said before, making the interface public is
orthogonal to compiling doxygen docs for it.
Would developers find it useful to have doxygen docs of the private APIs?
> Cheers,
> -g
Re: svn commit: r1173935 - /subversion/trunk/subversion/include/private/svn_subr_private.h
Posted by Greg Stein <gs...@gmail.com>.
On Thu, Sep 22, 2011 at 13:55, Daniel Shahaf <d....@daniel.shahaf.name> wrote:
> Greg Stein wrote on Thu, Sep 22, 2011 at 13:33:37 -0400:
>...
>> Can we get the nightly to do it? ie. for devs rather than part of official
>> released API doc?
>
> This would require someone to convert all the docs in
> subversion/include/private/ to the doxygen format. I think between OCD
> and scripting abilities someone can make the conversion. (if we want to
> do it)
Good point.
*shrug*
I just kinda used doxygen as a default. I doubt that we'd want to
expose the spillbuf interface because it probably won't be used in any
of our public APIs, and it doesn't directly relate to Subversion.
Cheers,
-g
Re: svn commit: r1173935 -
/subversion/trunk/subversion/include/private/svn_subr_private.h
Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Greg Stein wrote on Thu, Sep 22, 2011 at 13:33:37 -0400:
> On Sep 22, 2011 2:49 AM, "Hyrum K Wright" <hy...@wandisco.com> wrote:
> >
> > On Thu, Sep 22, 2011 at 3:31 AM, <da...@apache.org> wrote:
> > > Author: danielsh
> > > Date: Thu Sep 22 02:31:06 2011
> > > New Revision: 1173935
> > >
> > > URL: http://svn.apache.org/viewvc?rev=1173935&view=rev
> > > Log:
> > > * subversion/include/private/svn_subr_private.h: Doxygen markup fixes.
> >
> > You probably already know this, but stuff in include/private doesn't
> > get processed by doxygen (and this comment wouldn't anyway, since it
> > doesn't lead with a '/**' ).
>
> Can we get the nightly to do it? ie. for devs rather than part of official
> released API doc?
>
This would require someone to convert all the docs in
subversion/include/private/ to the doxygen format. I think between OCD
and scripting abilities someone can make the conversion. (if we want to
do it)
> Cheers,
> -g
Re: svn commit: r1173935 - /subversion/trunk/subversion/include/private/svn_subr_private.h
Posted by Greg Stein <gs...@gmail.com>.
On Sep 22, 2011 2:49 AM, "Hyrum K Wright" <hy...@wandisco.com> wrote:
>
> On Thu, Sep 22, 2011 at 3:31 AM, <da...@apache.org> wrote:
> > Author: danielsh
> > Date: Thu Sep 22 02:31:06 2011
> > New Revision: 1173935
> >
> > URL: http://svn.apache.org/viewvc?rev=1173935&view=rev
> > Log:
> > * subversion/include/private/svn_subr_private.h: Doxygen markup fixes.
>
> You probably already know this, but stuff in include/private doesn't
> get processed by doxygen (and this comment wouldn't anyway, since it
> doesn't lead with a '/**' ).
Can we get the nightly to do it? ie. for devs rather than part of official
released API doc?
Cheers,
-g
Re: svn commit: r1173935 -
/subversion/trunk/subversion/include/private/svn_subr_private.h
Posted by Daniel Shahaf <da...@elego.de>.
Hyrum K Wright wrote on Thu, Sep 22, 2011 at 07:49:17 +0100:
> On Thu, Sep 22, 2011 at 3:31 AM, <da...@apache.org> wrote:
> > Author: danielsh
> > Date: Thu Sep 22 02:31:06 2011
> > New Revision: 1173935
> >
> > URL: http://svn.apache.org/viewvc?rev=1173935&view=rev
> > Log:
> > * subversion/include/private/svn_subr_private.h: Doxygen markup fixes.
>
> You probably already know this, but stuff in include/private doesn't
> get processed by doxygen (and this comment wouldn't anyway, since it
> doesn't lead with a '/**' ).
>
True, but the comments do use doxygen syntax.
> > -/* Write @a len bytes from @a data into the spill-buffer in @reader. */