Re: HOW TO: JAVADOC_AUTOBRIEF with no brief?
Robert Dailey <rcdailey <at> gmail.com>
2007-12-03 21:21:12 GMT
In my original inquiry I had mentioned that I would like to work around
this without setting JAVADOC_AUTOBRIEF to NO. So far, I find that this
works:
class directx_exception : public std::exception
{
public:
///.
/// <at> param errorCode HRESULT returned by the directx function that is the source of the exception.
/// <at> param message A custom user message.
/// <at> param line The line number representing the location of the exception.
/// <at> param file A file name representing the location of the exception.
directx_exception( HRESULT errorCode, const char* message, unsigned int line, const char* file );
};
However, doing it this way has 2 issues:
1) It leaves an arbitrary carriage return under each member of the class (additional wasted space in the HTML output).
2)
It causes the following unnecessary warning in the doxygen output:
"Warning: End of list marker found without any preceding list items"
Any ideas?
On Dec 3, 2007 3:03 PM, Paul Joireman <
joireman <at> fnal.gov> wrote:
If you set JAVADOC_AUTOBRIEF to NO, the first line will not be
considered as the brief description. When you want a brief use the
\brief tag, when you don't want a brief description leave this
out and no brief will be generated. However, this does require you to change
other functions that have the first line as a brief description.
--Paul
I have the following code:
class directx_exception : public std::exception
{
public:
/// <at> param errorCode HRESULT returned by
the directx function that is the source of the exception.
/// <at> param message A custom user message.
/// <at> param line The line number representing
the location of the exception.
/// <at> param file A file name representing
the location of the exception.
directx_exception( HRESULT errorCode,
const char* message, unsigned int line, const char* file );
};
However, doxygen treats the first <at> param as the brief description since I have
JAVADOC_AUTOBRIEF set to YES. This is the correct behavior given the
functionality description of AUTOBRIEF, however I'm wondering how I can modify
the settings file or the code documentation to not treat the first <at> param as a
brief? Basically, I want the code above to have *no* brief description while
still keeping AUTOBRIEF set to YES. I would really hate to have to do something
cheesy like "///." to make it skip the brief.
Thanks.
-------------------------------------------------------------------------
SF.Net email is sponsored by: The Future of Linux Business White Paper
from Novell. From the desktop to the data center, Linux is going
mainstream. Let it simplify your IT future.
http://altfarm.mediaplex.com/ad/ck/8857-50307-18918-4
_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
RSS Feed