doxygen-users

[Doxygen-users] Struct members displaying inconveniently

[Moritz V. <ma...@mo...>]

A revamping of a former question of mine:
I have structs that contain function pointers, to serve as interfaces. =
Doxygen documents them as...

	const gchar*(* IResources::EntryName)(SLR_DIRECTORY directory, guint =
index) =20

...for example. I'd like to have them shown as...

	const gchar* EntryName (SLR_DIRECTORY directory, guint index) =20

...or...

	const gchar* IResources::EntryName (SLR_DIRECTORY directory, guint =
index) =20

...instead.

Is this possible? If so, how?=20

--
Regards,
 Moritz Voss=20

Re: [Doxygen-users] Struct members displaying inconveniently

[<eds...@ya...>]

The correct function pointer syntax is the syntax that
Doxygen uses: 

const gchar* (*IResources::EntryName) (....);

As a liberality (syntatic sugar), C++ allows you to
CALL (not declare) the function pointed to by
EntryName as:

IResources st;
st.EntryName = ...address of some function...;
st.EntryName ();

instead of the old K&R C style:

(*st.EntryName) ();

but you must not declare a function pointer as it
would be a method declaration:

const gchar* IResources::EntryName (....);

is a declaration of a method that returns a const
gchar * ...


 --- Moritz Voss <ma...@mo...> WROTE: > A
revamping of a former question of mine:
> I have structs that contain function pointers, to
> serve as interfaces. Doxygen documents them as...
> 
> 	const gchar*(* IResources::EntryName)(SLR_DIRECTORY
> directory, guint index)  
> 
> ...for example. I'd like to have them shown as...
> 
> 	const gchar* EntryName (SLR_DIRECTORY directory,
> guint index)  
> 
> ...or...
> 
> 	const gchar* IResources::EntryName (SLR_DIRECTORY
> directory, guint index)  
> 
> ...instead.
> 
> Is this possible? If so, how? 
> 
> --
> Regards,
>  Moritz Voss 
> 
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
>
https://lists.sourceforge.net/lists/listinfo/doxygen-users 

_______________________________________________________________________________________________
Yahoo! Empregos
O trabalho dos seus sonhos pode estar aqui. Cadastre-se hoje mesmo no Yahoo! Empregos e tenha acesso a milhares de vagas abertas!
http://br.empregos.yahoo.com/

RE: [Doxygen-users] Struct members displaying inconveniently

[Moritz V. <th...@gm...>]

Hehe!

My point was, I want Doxygen to display it differently from the correct =
syntax which we're using :) Simply because it'd make it feel more like =
C++, not like C bent in ways it's not supposed to go (object =
orientation).


I actually wasn't aware, though, that K&R requires the function to be =
called=20

> (*st.EntryName) ();

this way. (thanks about that, but it's irrelevant as for my problem)


--
Regards,
 Moritz Voss=20

Re: [Doxygen-users] Struct members displaying inconveniently

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

On Thu, Mar 07, 2002 at 11:35:34AM +0100, Moritz Voss wrote:
> A revamping of a former question of mine:
> I have structs that contain function pointers, to serve as interfaces. Doxygen documents them as...
> 
> 	const gchar*(* IResources::EntryName)(SLR_DIRECTORY directory, guint index)  
> 
> ...for example. I'd like to have them shown as...
> 
> 	const gchar* EntryName (SLR_DIRECTORY directory, guint index)  
> 
> ...or...
> 
> 	const gchar* IResources::EntryName (SLR_DIRECTORY directory, guint index)  
> 
> ...instead.
> 
> Is this possible? If so, how? 

This is possible by writing an input filter that does the translation
and let doxygen use that to filter the input (INPUT_FILTER).

An alternative is to package the function pointer into macros, and let
doxygen's preprocessor expand them in the way you want. But this requires
changes to the original code.

Regards,
  Dimitri

[Doxygen-users] Example summaries in the example list

[Jeff G. <je...@cr...>]

Is there a way to get example summaries into the example list?

Currently if I do something like:

/*! @example foo.cpp This example demonstrates.... */

In the example list we only get a list of .cpp files without any descriptions.
I didn't see a way to do this -- am I missing something or is this a feature
request?

Thanks,

Jeff