couple of ideas for "Document Declaration"

Morten Volden mvolden2 at
Thu Mar 29 17:16:30 UTC 2012

2012/3/29 Yngve Inntjore Levinsen <yngve.levinsen at>

> Hi,
> I was just using the "Document Declaration" now (in C++), and there are a
> couple of points I figured might be worth while suggesting.
> 1. If the function is a void, what about not adding the line "@return
> void"? I
> don't see how that information is useful...


> 2. What about adding "@author %{fullname} <%{email}>"? In the snippets
> these
> macros are defined and will automatically put my name and e-mail. To me it
> is
> quite useful on a bigger project to know who wrote a given
> function/class...?
On a bigger project there will usually be any number of authors on a given
function/class. Wouldn't it make more sense to use the version control
system to retrieve that information?

> 3. You could consider to add the line "@date %{year}" (or perhaps
> year-month)
> as well..?
> Cheers,
> Yngve
> _______________________________________________
> kdevelop mailing list
> kdevelop at

- When the split is pulled, mr. Grenade is no longer our friend
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <>

More information about the KDevelop mailing list