[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: C. Michael Pilato <cmpilato_at_collab.net>
Date: 2007-11-07 20:55:07 CET

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?

-- 
C. Michael Pilato <cmpilato@collab.net>
CollabNet   <>   www.collab.net   <>   Distributed Development On Demand

Received on Wed Nov 7 20:55:18 2007

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