[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: Introductory text for Doxygen-generated API documentation

From: Daniel Rall <dlr_at_collab.net>
Date: 2007-11-07 23:01:27 CET

On Wed, 07 Nov 2007, C. Michael Pilato wrote:

> Hyrum K. Wright wrote:
> > Daniel Rall wrote:
> >> While I agree that this text is a valuable addition, I really dislike
> >> having it in svn_client.h (since it is applicable to a much broader
> >> scope than svn_client.h). On IRC yesterday, we discussed using a
> >> separate header file instead.
> >
> > We did. I went ahead and committed it, but we can move it around (or
> > change the text) as we see fit.
> >
> > We really don't have a single, all-inclusive "svn.h" header file, which
> > would be the ideal place to put something like this. Going through the
> > Doxygen manual, it appears that the introduction just needs to be
> > anywhere in the list of files which we document. In our case, these are
> > the public header files: subversion/include/*.h
> >
> > I have no objection to putting this text somewhere else in one of our
> > other public header files. I think creating a separate file just for
> > this purpose is a bit overkill. This is a limitation of the tool, which
> > we need to work around.
> >
> > Any suggestions?
>
> My mind always thinks of svn_types.h as sort of our "root header file". How
> about there?

Yeah, you certainly can't do much without svn_types.h; that's a better
spot than svn_client.h.

As I mentioned on IRC, I see a private Doxygen-specific header file to
be the best solution. I've configured Doxygen to handle that, and
moved the text into such a header in r27671.

  • application/pgp-signature attachment: stored
Received on Wed Nov 7 23:01:39 2007

This is an archived mail posted to the Subversion Dev mailing list.