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

Introductory text for Doxygen-generated API documentation

From: Daniel Rall <dlr_at_collab.net>
Date: 2007-11-07 20:32:57 CET

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.

On Wed, 07 Nov 2007, hwright@tigris.org wrote:

> Author: hwright
> Date: Wed Nov 7 11:12:19 2007
> New Revision: 27661
>
> Log:
> Add a bit of introductory text to our Doxygen docs. The location of this text
> is somewhat arbitrary, it needs only live somewhere in the files which are
> processed by doxygen. I couldn't find a way to include this text somewhere
> outside of the source tree, but I think it is valuable to have some front
> matter to our generated API documentation.
>
> * subversion/include/svn_client.h:
> Add a comment which includes introductory text for the generated API docs.
>
>
> Modified:
> trunk/subversion/include/svn_client.h
>
> Modified: trunk/subversion/include/svn_client.h
> URL: http://svn.collab.net/viewvc/svn/trunk/subversion/include/svn_client.h?pathrev=27661&r1=27660&r2=27661
> ==============================================================================
> --- trunk/subversion/include/svn_client.h (original)
> +++ trunk/subversion/include/svn_client.h Wed Nov 7 11:12:19 2007
> @@ -4191,3 +4191,18 @@
> #endif /* __cplusplus */
>
> #endif /* SVN_CLIENT_H */
> +
> +/* The following comment adds some text to the main doxygen page. I've
> + * put it here, because I don't know of a better place. Feel free to
> + * move it if a more suitable home can be found. */
> +/**
> + * @mainpage Subversion Documentation
> + *
> + * This documentation covers the public APIs provided by the Subversion
> + * libraries. It is intended mainly for programmers, both those working
> + * on Subversion itself, as well as developers of 3rd-party applications
> + * intending to use these APIs. For more information about using Subversion,
> + * see the Subversion Book at http://svnbook.red-bean.com/.
> + *
> + * To learn more about Subversion, please visit http://subversion.tigris.org/.
> + */
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: svn-unsubscribe@subversion.tigris.org
> For additional commands, e-mail: svn-help@subversion.tigris.org

  • application/pgp-signature attachment: stored
Received on Wed Nov 7 20:34:24 2007

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