[rtems commit] score: Doxygen Clean Up Task #4

[Gedare Bloom]

On Tue, Jan 8, 2013 at 1:01 PM, Ralf Corsepius <ralf.corsepius at rtems.org> wrote:
> On 01/08/2013 06:36 PM, Jennifer Averett wrote:
>>
>> Module:    rtems
>> Branch:    master
>> Commit:    1362b7a6d067d26e0409b226947f676016ee7135
>>
>> Changeset:http://git.rtems.org/rtems/commit/?id=1362b7a6d067d26e0409b226947f676016ee7135
>>
>> Author:    Alex Ivanov<alexivanov97 at gmail.com>
>> Date:      Tue Jan  8 11:39:08 2013 -0600
>>
>> score: Doxygen Clean Up Task #4
>
>
>> diff --git a/cpukit/score/cpu/h8300/rtems/score/cpu.h
>> b/cpukit/score/cpu/h8300/rtems/score/cpu.h
>> index f8f41a8..6031f96 100644
>> --- a/cpukit/score/cpu/h8300/rtems/score/cpu.h
>> +++ b/cpukit/score/cpu/h8300/rtems/score/cpu.h
>> @@ -1,11 +1,13 @@
>>   /**
>> - * @file rtems/score/cpu.h
>> + * @file
>
>
> Jennifer, are you sure these changes are correct?
>
> The RTEMS doxygen generated docs are API docs, i.e. the @file directives are
> supposed to point to the place a file is being installed, not to the place a
> file is located inside of the source tree.
>
They may be API docs, but I think they are for developers, not for
users. So to me it makes more sense to know where the file is in the
source tree.

> Ralf
>
> PS.: I regret to permanently complain about the doxygen changes, but I feel
> you folks are seriously breaking it.
It is good to have a critical eye. I don't think anything has been so
broken it cannot easily be fixed or adjusted. A lot of these doxygen
changes are to simplify maintenance by relocating existing comments
into header files and to make files more uniform. In the long run that
should help with adding and updating doxygen comments.

>
> _______________________________________________
> rtems-devel mailing list
> rtems-devel at rtems.org
> http://www.rtems.org/mailman/listinfo/rtems-devel