Re: Doxygen appends a dot at the end of a brief description

Duane Ellis <[email protected]>
Newsgroups gmane.text.doxygen.devel
Message-ID <OF84DE6AFB.87D8D48E-ON85257068.004B24AD-85257068.004D86B2@franklin.com>
> > 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.



-------------------------------------------------------
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
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.