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

Re: Doxygen policy ideas

From: Max Bowsher <maxb_at_ukf.net>
Date: 2005-04-08 17:13:33 CEST

Julian Foad wrote:
>> SUMMARY
>>
>> Noticing that our Doxygen HTML API documentation is rather untidy, I
>> submit
>> that we ought to document and improve our use of Doxygen mark-up, to make
>> it >> easier to learn and to apply correctly, and to make the result more
>> consistent, more attractive and more useful. I present a proposal and
>> solicit
>> feedback.

Yes! Very definitely!

One addition:

We should start to put stuff on the main page (@mainpage), and use it, and
extra pages, to document aspects of the API which spread across multiple
symbols - for example:
Pool is last argument
Policy on NULL inputs
Description of how to use errors, and SVN_ERR()

Max.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Fri Apr 8 17:19:15 2005

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