doxygen-users

[Doxygen-users] Re: Documenting C

[Scot W. <sc...@wi...>]

I am having the same problem.  *.c files create no output with EXTRACT_ALL=NO.  
My .h file does create output, so doxygen is indeed running and looking at 
files.  I tried various comments within a .c file with no reaction.

Doxygen 1.2.13.1 on Solaris 8 SPARC.

> FROM: Bernd Brandstetter
> DATE: 12/05/2001 09:49:53
> SUBJECT:  [Doxygen-users] Documenting C 
> 
> While I'm very satisfied with doxygen's output for C++ files I didn't 
> manage to get a reasonable result for C code. In fact, doxygen doesn't 
> document anything besides the file list as long as I don't set 
> EXTRACT_ALL to YES in which case it really documents everything -- 
> including all structures and functions which I don't want to be documented 
> and therefore didn't spend a doxygen comment.
> 
> This is independent of the settings of EXTRACT_PRIVATE, EXTRACT_STATIC, 
> HIDE_UNDOC_MEMBERS and OPTIMIZE_OUTPUT_FOR_C.

[Doxygen-users] Re: Documenting C

[Scot W. <sc...@wi...>]

Thanks to those that pointed out that my .c file needs a "\file" definition.  
Once this was pointed out I was able to find the documentation which 
mentions "repeat that, because it is often overlooked".  Yeah.

I think the need to use "\file" for non-data files should be stated at the 
start of the "Documenting the Code" info, not obtusely in page 7.

At least I can mention it here for the archives, even if there is no search 
capability for the group.

> I am having the same problem.  *.c files create no output with
> EXTRACT_ALL=NO.  
> My .h file does create output, so doxygen is indeed running and looking
> at 
> files.  I tried various comments within a .c file with no reaction.
> > FROM: Bernd Brandstetter
> > DATE: 12/05/2001 09:49:53
> > SUBJECT:  [Doxygen-users] Documenting C 
> >
> > While I'm very satisfied with doxygen's output for C++ files I didn't
> > manage to get a reasonable result for C code. In fact, doxygen doesn't
> > document anything besides the file list as long as I don't set 
> > EXTRACT_ALL to YES in which case it really documents everything -- 
> > including all structures and functions which I don't want to be
> documented 
> > and therefore didn't spend a doxygen comment.
> > 
> > This is independent of the settings of EXTRACT_PRIVATE,
> EXTRACT_STATIC, 
> > HIDE_UNDOC_MEMBERS and OPTIMIZE_OUTPUT_FOR_C.

Re: [Doxygen-users] Re: Documenting C

[Dimitri v. H. <di...@st...>]

On Wed, Jan 16, 2002 at 10:46:41AM -0600, Scot Wilcoxon wrote:
> I am having the same problem.  *.c files create no output with EXTRACT_ALL=NO.  
> My .h file does create output, so doxygen is indeed running and looking at 
> files.  I tried various comments within a .c file with no reaction.

And you also tried to put a comment like

/*! \file
 *  Docs for this file.
 */

in each .c file? If so send me a bug report, if not, reread FAQ #3

Regards,
  Dimitri

> Doxygen 1.2.13.1 on Solaris 8 SPARC.
> 
> > FROM: Bernd Brandstetter
> > DATE: 12/05/2001 09:49:53
> > SUBJECT:  [Doxygen-users] Documenting C 
> > 
> > While I'm very satisfied with doxygen's output for C++ files I didn't 
> > manage to get a reasonable result for C code. In fact, doxygen doesn't 
> > document anything besides the file list as long as I don't set 
> > EXTRACT_ALL to YES in which case it really documents everything -- 
> > including all structures and functions which I don't want to be documented 
> > and therefore didn't spend a doxygen comment.
> > 
> > This is independent of the settings of EXTRACT_PRIVATE, EXTRACT_STATIC, 
> > HIDE_UNDOC_MEMBERS and OPTIMIZE_OUTPUT_FOR_C.
>