Re: doxygen @short directive in comments

[Albert Strasheim]

Hello,

On Mon, 06 Jan 2003, Federico Montesino Pouzols wrote:

>       Um, yes this should be fixed. Another pending issue with the
> doxygen doc is that, as reported sometime ago, ost::Exception does not
> appear in it. This is because there is a specific doc/cc++/config.h
> for doxygen which only defines a few configuration constants. Should
> not we remove this file and simply use the config.h generated by
> configure?

Sounds like a plan. Don't know why this hasn't been done all along. I 
wouldn't want my docs to reflect some other system.

Here's a more general question: how is any autoconf/automake project 
supposed to use the config.h file?

It seems to be as if the right way to go about things is to have 
autoconf generate a config.h header which you include with your 
installed headers (which seems to be what Common C++ does), and always 
include if you need configuration info in your other headers.

BTW, with autoconf 2.57, reconfig prints the following warning message 
when you generate the files for the build system:

address@hidden:~/work/commoncpp2> ./reconfig
Putting files in AC_CONFIG_AUX_DIR, `config'.
WARNING: Using auxiliary files such as `acconfig.h', `config.h.bot'
WARNING: and `config.h.top', to define templates for `config.h.in'
WARNING: is deprecated and discouraged.

WARNING: Using the third argument of `AC_DEFINE' and
WARNING: `AC_DEFINE_UNQUOTED' allows to define a template without
WARNING: `acconfig.h':

WARNING:   AC_DEFINE([NEED_MAIN], 1,
WARNING:             [Define if a function `main' is needed.])

WARNING: More sophisticated templates can also be produced, see the
WARNING: documentation.

Cheers,

Albert