doxygen-develop

[Doxygen-develop] Wish: have an unimplemented attribute

[Paul D. <duf...@gm...>]

For a big project, we sometime begin by writing stub functions just
returning a no error code. And it is sometimes hard to know what have
been implemented or not without going all the sources.

Being able to add an unimplemented attribute, would be nice.
Moreover if the list of functions (or members, etc) that still need to
be implemented would be listed, perhaps inside the todo page.

Re: [Doxygen-develop] Wish: have an unimplemented attribute

[Peter M. <pm...@fr...>]

On Wed, Jul 30 2008, Paul Dufresne wrote:

> Being able to add an unimplemented attribute, would be nice.
> Moreover if the list of functions (or members, etc) that still need to
> be implemented would be listed, perhaps inside the todo page.

I think, this is just the purpose of the \todo command. I use it like this:
\todo still to be done
Cheers, Peter

-- 
http://pmrb.free.fr/contact/

Re: [Doxygen-develop] Wish: have an unimplemented attribute

[Paul D. <duf...@gm...>]

2008/7/31 Peter Münster <pm...@fr...>:
> On Wed, Jul 30 2008, Paul Dufresne wrote:
>
>> Being able to add an unimplemented attribute, would be nice.
>> Moreover if the list of functions (or members, etc) that still need to
>> be implemented would be listed, perhaps inside the todo page.
>
> I think, this is just the purpose of the \todo command. I use it like this:
> \todo still to be done
> Cheers, Peter

I'd prefer to keep todo for stuff like: reimplement using this, or
move that code to ..., etc.
But yes, I admit that it could be used for that. Maybe even to alias
\unimplemented to \todo would be nearer. But for me, I still think
that having an attribute just for that would be best.

Re: [Doxygen-develop] Wish: have an unimplemented attribute

[Erik Z. <ze...@ma...>]

On Thu, Jul 31, 2008 at 4:47 PM, Paul Dufresne <duf...@gm...> wrote:
> 2008/7/31 Peter Münster <pm...@fr...>:
>> On Wed, Jul 30 2008, Paul Dufresne wrote:
>>
>>> Being able to add an unimplemented attribute, would be nice.
>>> Moreover if the list of functions (or members, etc) that still need to
>>> be implemented would be listed, perhaps inside the todo page.
>>
>> I think, this is just the purpose of the \todo command. I use it like this:
>> \todo still to be done
>> Cheers, Peter
>
> I'd prefer to keep todo for stuff like: reimplement using this, or
> move that code to ..., etc.
> But yes, I admit that it could be used for that. Maybe even to alias
> \unimplemented to \todo would be nearer. But for me, I still think
> that having an attribute just for that would be best.
>

What you're looking for is \xrefitem.

http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem

Erik

-- 
*************************************************
Erik Zeek
ze...@ma...
*************************************************
Against stupidity the very gods
Themselves contend in vain.
 - Johann Christoph Friedrich von Schiller (1801)
*************************************************

Re: [Doxygen-develop] Wish: have an unimplemented attribute

[Paul D. <duf...@gm...>]

>> But yes, I admit that it could be used for that. Maybe even to alias
>> \unimplemented to \todo would be nearer. But for me, I still think
>> that having an attribute just for that would be best.
>>
>
> What you're looking for is \xrefitem.
>
> http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem
>
> Erik
>
> --
> *************************************************
> Erik Zeek
> ze...@ma...
> *************************************************

Hey, indeed it seems to be what I need. Thanks!