Dude (nice nickname)
One possible solution is to place conditional guards around your prototypes
in the files where you don't want them included:
/* @cond ONLY_INCLUDE_THE_FOLLOWING_IF_I_DEFINE_THIS_NAME */
Function prototypes go here
/* @endcond */
Place these two comments around what you don't want included and don't
define the ONLY_INCLUDE_THE_FOLLOWING_IF_I_DEFINE_THIS_NAME
in your doxyfile. This allows you to document other things in the same
file and have them recognized by doxygen.
Regards,
Paul
On Mon, Feb 4, 2013 at 3:25 PM, TheDude <hendrix1...@yahoo.com> wrote:
> So I have a C program that is split into multiple objects. My makefile
> looks
> like this:
>
> *all: fadingsim.o jakesimulator.o dspmath_fp.o
> g++ fadingsim.o jakesimulator.o dspmath_fp.o -o fadingsim
> #Main#
> fadingsim.o: fadingsim.c constants.h
> g++ -c -Wall fadingsim.c
>
> jakesimulator.o: jakesimulator.c jakesimulator.h constants.h
> g++ -c -Wall jakesimulator.c
>
> dspmath_fp.o: dspmath_fp.c dspmath_fp.h constants.h
> g++ -c -Wall dspmath_fp.c*
>
> Now, in my main function I have:
>
> *
> extern void getMagnitude(double h[], double hmag[], int len, int
> normalize);
> extern double getPMF(double x[], int len, double pmf[], int step);*
>
> These functions are declared in the dspmath_fp.h file and defined in
> dspmath_fp.c . When I generate the documentation (as a Latex document), I
> would like it so that the file reference for the main function does not
> include the externs as functions in the file. Rather, I would like these
> functions to ONLY be documented in dspmath_fp.c, and nowhere else.
>
> As I'm doing it now, by placing file identifiers on each file and doing in
> body function documentation, these three functions get repeated in the file
> reference for dspmath, the main file, and anywhere else that needs to call
> them.
>
> How can separate the documentation?
>
> Thanks!!
>
>
>
> --
> View this message in context:
> http://doxygen.10944.n7.nabble.com/Avoiding-repeat-function-documentation-in-Doxygen-tp5623.html
> Sent from the Doxygen - Users mailing list archive at Nabble.com.
>
>
> ------------------------------------------------------------------------------
> Everyone hates slow websites. So do we.
> Make your web apps faster with AppDynamics
> Download AppDynamics Lite for free today:
> http://p.sf.net/sfu/appdyn_d2d_jan
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
--
Paul W. Joireman
paul.joire...@gmail.com
----------------------------------------------------------------
'Am I not destroying my enemies when I make friends of them? ."
-- Abraham Lincoln 1809-1865
------------------------------------------------------------------------------
Everyone hates slow websites. So do we.
Make your web apps faster with AppDynamics
Download AppDynamics Lite for free today:
http://p.sf.net/sfu/appdyn_d2d_jan
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
