[prev in list] [next in list] [prev in thread] [next in thread]
List: doxygen-users
Subject: Re: [Doxygen-users] Header file parsed without '\file' ('@file')
From: Travis Everett <travis.a.everett () gmail ! com>
Date: 2018-05-10 13:01:41
Message-ID: CAC=jSUU9unBbwFqUKPiU4gzDzsq9L9qKj0X8PvS1k+o5kwYqzQ () mail ! gmail ! com
[Download RAW message or body]
[Attachment #2 (multipart/alternative)]
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 <public.forum.profile@gmail.com>
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
> Doxygen-users@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
[Attachment #5 (text/html)]
<div dir="ltr">I think Doxygen's still going to parse anything that matches your \
input config; it just doesn't necessarily document \
it.<div><br></div><div>Regarding the warnings themselves, see \
WARN_IF_UNDOCUMENTED.</div></div><br><div class="gmail_quote"><div dir="ltr">On Thu, \
May 10, 2018 at 4:02 AM Joe Bloggs <<a \
href="mailto:public.forum.profile@gmail.com">public.forum.profile@gmail.com</a>> \
wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 \
.8ex;border-left:1px #ccc solid;padding-left:1ex"><div \
dir="ltr">Hi,<div><br></div><div>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)</div><div><br></div><div>1) create a new \
empty directory</div><div>2) in the directory create "example.h" with the \
following content:</div><div><br></div><div><div>typedef \
struct</div><div>{</div><div><span style="white-space:pre-wrap"> </span>int \
i;</div><div>} S;</div></div><div><br></div><div>3) auto-generate a Doxyfile with \
"doxygen -g"</div><div>4) run Doxygen</div><div><br></div><div>I see two \
warnings:</div><div><br></div><div>C:/temp/example.h:2: warning: Compound S is not \
documented.<br></div><div>C:/temp/example.h:3: warning: Member i (variable) of class \
S is not documented.<br></div><div><br></div><div>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'?</div><div><br></div><div>Thanks.</div></div>
------------------------------------------------------------------------------<br>
Check out the vibrant tech community on one of the world's most<br>
engaging tech sites, Slashdot.org! <a href="http://sdm.link/slashdot" \
rel="noreferrer" target="_blank">http://sdm.link/slashdot</a>_______________________________________________<br>
Doxygen-users mailing list<br>
<a href="mailto:Doxygen-users@lists.sourceforge.net" \
target="_blank">Doxygen-users@lists.sourceforge.net</a><br> <a \
href="https://lists.sourceforge.net/lists/listinfo/doxygen-users" rel="noreferrer" \
target="_blank">https://lists.sourceforge.net/lists/listinfo/doxygen-users</a><br> \
</blockquote></div>
------------------------------------------------------------------------------
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
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic