Andreas Schneider | 7 May 10:32 2010

Doxygen messes up with PRINTF_ATTRIBUTES macro

Hi,

I've created API documentation for talloc.samba.org. Doxygen has a problem 
correctly creating documentation for a function which has a printf attribute 
checking at the end using a macro.

#define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))                                                                               
#else                                                                                                                                                        
#define PRINTF_ATTRIBUTE(a1, a2)                                                                                                                             
#endif                                                                                                                                                       
#endif

void *talloc_init(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2); 

It adds the return value of this function to the output of the next.

void * 	talloc_init (const char *fmt,...) PRINTF_ATTRIBUTE(1
 	Create a new top level talloc context.

void *int 	talloc_free (void *ptr)
 	Free a chunk of talloc memory. 

See http://talloc.samba.org/talloc/doc/html/group__talloc.html

I can work around the problem using #ifdef DOXYGEN but I think it should be 
fixed in doxygen.

Cheers,

	-- andreas
(Continue reading)

Dimitri Van Heesch | 7 May 20:48 2010
Picon

Re: Doxygen messes up with PRINTF_ATTRIBUTES macro

Hi Andreas,

On 7 mei 2010, at 10:32, Andreas Schneider wrote:

> Hi,
>
> I've created API documentation for talloc.samba.org. Doxygen has a  
> problem
> correctly creating documentation for a function which has a printf  
> attribute
> checking at the end using a macro.
>
> #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__,  
> a1, a2)))
> #else
> #define PRINTF_ATTRIBUTE(a1, a2)
> #endif
> #endif
>
> void *talloc_init(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2);
>
> It adds the return value of this function to the output of the next.
>
> void * 	talloc_init (const char *fmt,...) PRINTF_ATTRIBUTE(1
> 	Create a new top level talloc context.
>
> void *int 	talloc_free (void *ptr)
> 	Free a chunk of talloc memory.
>
>
(Continue reading)

Dimitri Van Heesch | 7 May 22:19 2010
Picon

Re: Doxygen messes up with PRINTF_ATTRIBUTES macro

Hi Andreas,

On 7 mei 2010, at 21:37, Andreas Schneider wrote:

> On Friday 07 May 2010 20:48:26 you wrote:
>> Hi Andreas,
>>
>> On 7 mei 2010, at 10:32, Andreas Schneider wrote:
>>> Hi,
>>>
>>> I've created API documentation for talloc.samba.org. Doxygen has a
>>> problem
>>> correctly creating documentation for a function which has a printf
>>> attribute
>>> checking at the end using a macro.
>>>
>>> #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__,
>>> a1, a2)))
>>> #else
>>> #define PRINTF_ATTRIBUTE(a1, a2)
>>> #endif
>>> #endif
>>>
>>> void *talloc_init(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2);
>>>
>>> It adds the return value of this function to the output of the next.
>>>
>>> void * 	talloc_init (const char *fmt,...) PRINTF_ATTRIBUTE(1
>>>
>>> 	Create a new top level talloc context.
(Continue reading)

Jan Eichhorn | 14 May 14:49 2010
Picon

Adding file name to caller graph nodes

Hi,

I'm mostly interested in call- and caller-graphs generated by doxygen. I
would like to add the filename of a function (i.e. where it is defined)
to its node in the graph.
Is there an easy way of doing this?
If not, where in the source code should I look to find my way?

Thanks for any efforts
Jan

------------------------------------------------------------------------------
Andrey Asadchev | 31 May 20:06 2010
Picon

inline template documentation

hello.

How hard would it to implement in line template documentation:

template<
  class F ///< documentation
>

can you please tell me where to start, I not familiar with internals.
Thank you

------------------------------------------------------------------------------

_______________________________________________
Doxygen-develop mailing list
Doxygen-develop <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-develop