On Sun, Aug 08, 2010 at 07:10:19PM +0200, Carl-Daniel Hailfinger wrote:
-/** +/*
- @cmpbuf buffer to compare against, cmpbuf[0] is expected to match the flash content at location start
- @start offset to the base address of the flash chip
@@ -765,7 +765,7 @@ return ret; }
-/** +/*
- Check if the buffer @have can be programmed to the content of @want without
- erasing. This is only possible if all chunks of size @gran are either kept
- as-is or changed from an all-ones state to any other state.
If the @variablename syntax is not doxygen, what is it?
No idea. I don't think Doxygen supports that, or at least I never heard of it. It might be an informal notation which is not meant for any tool at all (?) or maybe for some other tool (?)
I know of the following two notations. Default is the Javadoc-style:
@param myvariable This variable does this and that. @return True if bla, false if blub.
Alternative (but crappy IMHO):
\param myvariable This variable does this and that. \return True if bla, false if blub.
Just writing
@myvariable This variable does this and that.
will not work as expected AFAIK (didn't try though, to be honest).
Uwe.