Re: [Doxygen-users] Header file parsed without '\file' ('@file')
Brought to you by:
dimitri
From: Travis E. <tra...@gm...> - 2018-05-10 13:02:00
|
I think Doxygen's still going to parse anything that matches your input config; it just doesn't necessarily document it. Regarding the warnings themselves, see WARN_IF_UNDOCUMENTED. On Thu, May 10, 2018 at 4:02 AM Joe Bloggs <pub...@gm...> wrote: > Hi, > > My understanding is that each file to be parsed by Doxygen should have at > minimum the '\file' or '@file' command. I have a simple example where I > get warnings from a file that shouldn't be parsed. The steps to reproduce > are (Doxygen v1.8.14) > > 1) create a new empty directory > 2) in the directory create "example.h" with the following content: > > typedef struct > { > int i; > } S; > > 3) auto-generate a Doxyfile with "doxygen -g" > 4) run Doxygen > > I see two warnings: > > C:/temp/example.h:2: warning: Compound S is not documented. > C:/temp/example.h:3: warning: Member i (variable) of class S is not > documented. > > I can see in the auto-generated Doxyfile that EXTRACT_ALL = NO so why do I > get these warnings when 'example.h' doesn't have '\file' or '@file'? > > Thanks. > > ------------------------------------------------------------------------------ > Check out the vibrant tech community on one of the world's most > engaging tech sites, Slashdot.org! http://sdm.link/slashdot > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > |