Re: [Doxygen-develop] Doxygen appends a dot at the end of a brief description
Brought to you by:
dimitri
From: Duane E. <dua...@fr...> - 2005-08-25 14:07:00
|
> > 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? > 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 ... I agree. The presence or non-presence of a "full-stop" (or period) is a linguistic, gramatical, or stylistic issue/choice left to the documentor. In some cases, this may well be a language specific issue. To have doxygen "fix what it thinks is wrong" - seems wrong to me. Doxygen is not a grammer checker and automatic grammer fixer. Doxygen is not a spell-checker with automatic spelling fixer. In my mind - doxygen should not become a "punctuation fixer" also. In subtle ways - having a period/full-stop enforcer smells/sounds very much like an option that does the following: Fix my curly brace and indentations to match somebody elses standard Its fine - if there was an option that does something like: Enable warnings about my sloppy sentence structure Enable warnings about my sloppy puncutation Enable warnings about my sloppy spelling -Duane. |