Re: Doxygen appends a dot at the end of a brief description
Alex Zuepke <[email protected]>
| Newsgroups | gmane.text.doxygen.devel |
|---|---|
| Message-ID | <[email protected]> |
Dimitri van Heesch wrote: > On 8/25/05, Alex Zuepke <[email protected]> wrote: > >>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 = 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? >> > > > 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? > > Regards, > Dimitri > > 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 brief description. But sometimes I have function descriptions without verbs and then the dot looks weird ... Best regards, Alex -- Alexander Züpke [email protected] SYSGO AG ~ Am Pfaffenstein 14 ~ 55270 Klein-Winternheim / Germany ------------------------------------------------------- SF.Net email is Sponsored by the Better Software Conference & EXPO September 19-22, 2005 * San Francisco, CA * Development Lifecycle Practices Agile & Plan-Driven Development * Managing Projects & Teams * Testing & QA Security * Process Improvement & Measurement * http://www.sqe.com/bsce5sf