Re: [Doxygen-develop] Doxygen appends a dot at the end of a brief description

[Alex Z. <az...@sy...>]

Dimitri van Heesch wrote:
> On 8/25/05, Alex Zuepke <az...@sy...> wrote:
>=20
>>Hello doxygen developers,
>>
>>I tried to get rid of the implicit dot "." at the end of brief
>>descriptions and found no configuration option to disable this feature
>>... so I added one:
>>
>>BRIEF_APPEND_DOT =3D YES
>>
>>If the BRIEF_APPEND_DOT tag is set to YES (the default) Doxygen will
>>append a dot (".") after each brief description.
>>Note: if OUTPUT_LANGUAGE is set to Chinese, Japanese, or Korean, no dot
>>will be appended.
>>
>>The appended patch is against doxygen 1.4.4 stable.
>>
>>What do you think about this?
>>
>=20
>=20
> I would like to understand why you think this option is needed, i.e.
> in which case does the dot appear when you do not want it?
>=20
> Regards,
>   Dimitri
>=20
>=20

Example:

/** @brief Retrieves value from something special. */
extern int getFoo(const char *bar);

/** @brief This sentence no verb */
extern int getBar(const char *foo);

In the generated docs, both functions have a dot at the end of their=20
brief description. But sometimes I have function descriptions without=20
verbs and then the dot looks weird ...


Best regards,
Alex

--=20
Alexander Z=FCpke                        ale...@sy...
SYSGO AG ~ Am Pfaffenstein 14 ~ 55270 Klein-Winternheim / Germany