Re: [Doxygen-users] Function Documentation Appears Twice When both .hand .c appear in INPUT section
Brought to you by:
dimitri
|
From: Clemens F. <c....@os...> - 2006-12-08 09:51:32
|
Hi Dave. On 8 Dec 2006 at 1:51, Dave Dodge wrote: > I think Doxygen is working normally here. ... > I think the reason for this is that Doxygen is producing a > distinct page/section of documentation for each input file, and a > function's documentation will be output in _each_ of those sections You are right. Sometimes things are so usuall that you don't recognize them anymore ... For my project with doxygen documentation I use the groupging feature very much, because in plain C I do not have class memberships. I create a group, put the *.c file(s) and the corresponding *.h file(s) in the group. All stuff like function documenations (I usually put only in the *.c file), documentation for constants and variables I put in the group. Now all the long texts and documentation are to be found under the group name. The file documenation of the *.c and *.h files of that group only contain the list of functions, variables and constants but no more documentation of them (which is only in the group). With hyperlinking this is very comfortable. Somehow this is a little similar to your suggestion of creating reference pages. Ofcourse this grouping requires a little thinking to identifiy modules. But that should be done in software engineering anyway. And mostly it is worth the effort. I am aware that I advertise this grouping so much only because in Ansi-C I don't have the class concept like in C++. Clemens |