Re: Header file parsed without '\file' ('@file')

Travis Everett <[email protected]> Thu, 10 May 2018 13:01:41 +0000
Newsgroups gmane.text.doxygen.general
Message-ID <CAC=jSUU9unBbwFqUKPiU4gzDzsq9L9qKj0X8PvS1k+o5kwYqzQ@mail.gmail.com>
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 <[email protected]>
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
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

------------------------------------------------------------------------------
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
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users