[prev in list] [next in list] [prev in thread] [next in thread] 

List:       doxygen-users
Subject:    Re: [Doxygen-users] when i document the *.h and the *.c files all
From:       Paul Joireman <joireman () fnal ! gov>
Date:       2009-11-30 18:34:03
Message-ID: 004601ca71eb$b0e1ed10$12a5c730$ () gov
[Download RAW message or body]

A solution I use is to bracket the function prototypes with \cond and
\endcond commands in the *.h
file, like so:

*.h file:

\**
  @cond INCLUDE_WITH_DOXYGEN
**/
 ...
 /* Function prototypes */
\**
  @endcond 
**/

As long as INCLUDE_WIH_DOXYGEN is not defined in your Doxyfile, the function
prototypes will be exclude from the *.h documentation.   In this model I'm
assuming that the marked up function comments are in the *.c file.  

Paul

> -----Original Message-----
> From: vivelafete [mailto:vivelafete@students.unibe.ch]
> Sent: Monday, November 30, 2009 11:10 AM
> To: doxygen-users@lists.sourceforge.net
> Subject: [Doxygen-users] when i document the *.h and the *.c files all
> functions are documented twice.
> 
> 
> I searched for a long time for a solution, but i couldn't find one.
> 
> Does anybody know how it's possible to document both files with:
> /*! \file example.c*/
> /*! \file example.h*/
> 
> but the defined functions just once?
> 
> Thanks in advance
> vivelafete
> --
> View this message in context: http://old.nabble.com/when-i-document-
> the-*.h-and-the-*.c-files-all-functions-are-documented-twice.-
> tp26578135p26578135.html
> Sent from the Doxygen - Users mailing list archive at Nabble.com.
> 
> 
> -----------------------------------------------------------------------
> -------
> Let Crystal Reports handle the reporting - Free Crystal Reports 2008
> 30-Day
> trial. Simplify your report design, integration and deployment - and
> focus on
> what you do best, core application coding. Discover what's new with
> Crystal Reports now.  http://p.sf.net/sfu/bobj-july
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/doxygen-users



------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day 
trial. Simplify your report design, integration and deployment - and focus on 
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
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]