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

Re: svn commit: rev 3978 - in trunk: subversion/include doc

From: Branko Čibej <brane_at_xbc.nu>
Date: 2002-12-04 19:30:12 CET

Greg Stein wrote:

>On Tue, Dec 03, 2002 at 08:35:40PM -0600, brane@tigris.org wrote:
>
>
>>...
>>+++ trunk/subversion/include/svn_time.h Tue Dec 3 20:35:38 2002
>>@@ -1,5 +1,9 @@
>>-/* svn_time.h: time/date utilities
>>- *
>>+/**
>>+ * @file svn_time.h
>>+ * @brief Time/date utilities
>>+ * @{
>>+ */
>>+/*
>> * ====================================================================
>> * Copyright (c) 2000-2002 CollabNet. All rights reserved.
>> *
>>@@ -15,7 +19,6 @@
>> * ====================================================================
>> */
>>
>>
>
>I think we should move the @file stuff after the copyright. The (c) header
>should probably be the very first thing in the file.
>
>So the header would look something like:
>
>/**
> * ====================================================================
> * Copyright (c) 2000-2002 CollabNet. All rights reserved.
> *
> * This software is licensed as described in the file COPYING, which
> * you should have received as part of this distribution. The terms
> * are also available at http://subversion.tigris.org/license-1.html.
> * If newer versions of this license are posted there, you may use a
> * newer version instead, at your option.
> *
> * This software consists of voluntary contributions made by many
> * individuals. For exact contribution history, see the revision
> * history and logs, available at http://subversion.tigris.org/.
> * ====================================================================
> *
> * @file svn_time.h
> * @brief Time/date utilities
> * @{
> */
>
>
>
Er, did you check what happens to the file description in the docs if
you do that? It's funny. :-)
The copyright comment mustn't start with a /**. Or maybe there's a
directive that tells Doxygen to ignore the copyright, I'll check.

-- 
Brane Čibej   <brane_at_xbc.nu>   http://www.xbc.nu/brane/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Wed Dec 4 19:30:58 2002

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