Doxygen appends a dot at the end of a brief description
Alex Zuepke <[email protected]>
| Newsgroups | gmane.text.doxygen.devel |
|---|---|
| Message-ID | <[email protected]> |
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?
Best regards,
Alex
--
Alexander Züpke [email protected]
SYSGO AG ~ Am Pfaffenstein 14 ~ 55270 Klein-Winternheim / Germany
doxygen-1.4.4_brief_append_dot-v1.patch
(text/plain, 5.1 KB)
diff -upr doxygen-1.4.4.vorher/Doxyfile doxygen-1.4.4/Doxyfile
--- doxygen-1.4.4.vorher/Doxyfile 2005-06-12 22:00:20.000000000 +0200
+++ doxygen-1.4.4/Doxyfile 2005-08-18 18:25:54.000000000 +0200
@@ -11,6 +11,7 @@ OUTPUT_LANGUAGE = English
USE_WINDOWS_ENCODING = NO
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
+BRIEF_APPEND_DOT = YES
ABBREVIATE_BRIEF =
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
diff -upr doxygen-1.4.4.vorher/addon/doxmlparser/Doxyfile doxygen-1.4.4/addon/doxmlparser/Doxyfile
--- doxygen-1.4.4.vorher/addon/doxmlparser/Doxyfile 2002-02-13 20:47:35.000000000 +0100
+++ doxygen-1.4.4/addon/doxmlparser/Doxyfile 2005-08-18 18:26:13.000000000 +0200
@@ -15,6 +15,7 @@ HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
+BRIEF_APPEND_DOT = YES
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = NO
diff -upr doxygen-1.4.4.vorher/addon/doxmlparser/Doxyfile.impl doxygen-1.4.4/addon/doxmlparser/Doxyfile.impl
--- doxygen-1.4.4.vorher/addon/doxmlparser/Doxyfile.impl 2002-04-01 19:13:39.000000000 +0200
+++ doxygen-1.4.4/addon/doxmlparser/Doxyfile.impl 2005-08-18 18:26:07.000000000 +0200
@@ -15,6 +15,7 @@ HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
+BRIEF_APPEND_DOT = YES
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = NO
diff -upr doxygen-1.4.4.vorher/doc/config.doc doxygen-1.4.4/doc/config.doc
--- doxygen-1.4.4.vorher/doc/config.doc 2005-07-03 18:31:22.000000000 +0200
+++ doxygen-1.4.4/doc/config.doc 2005-08-18 18:34:58.000000000 +0200
@@ -61,6 +61,7 @@ followed by the descriptions of the tags
\refitem cfg_alphabetical_index ALPHABETICAL_INDEX
\refitem cfg_always_detailed_sec ALWAYS_DETAILED_SEC
\refitem cfg_binary_toc BINARY_TOC
+\refitem cfg_brief_append_dot BRIEF_APPEND_DOT
\refitem cfg_brief_member_desc BRIEF_MEMBER_DESC
\refitem cfg_call_graph CALL_GRAPH
\refitem cfg_case_sense_names CASE_SENSE_NAMES
@@ -298,6 +299,15 @@ followed by the descriptions of the tags
If both \c HIDE_UNDOC_MEMBERS and \c BRIEF_MEMBER_DESC are set to \c NO, the
brief descriptions will be completely suppressed.
+\anchor cfg_brief_append_dot
+<dt>\c BRIEF_APPEND_DOT <dd>
+ \addindex BRIEF_APPEND_DOT
+ If the \c BRIEF_APPEND_DOT tag is set to \c YES (the default) Doxygen will append
+ a dot (".") after each brief description.
+ \par Note:
+ If \c OUTPUT_LANGUAGE is set to \c Chinese, \c Japanese, or Korean, no dot
+ will be appended.
+
\anchor cfg_abbreviate_brief
<dt>\c ABBREVIATE_BRIEF <dd>
\addindex ABBREVIATE_BRIEF
diff -upr doxygen-1.4.4.vorher/qtools/Doxyfile doxygen-1.4.4/qtools/Doxyfile
--- doxygen-1.4.4.vorher/qtools/Doxyfile 2004-05-16 19:13:44.000000000 +0200
+++ doxygen-1.4.4/qtools/Doxyfile 2005-08-18 18:35:12.000000000 +0200
@@ -76,6 +76,13 @@ BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = 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.
+
+BRIEF_APPEND_DOT = YES
+
# This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings. Each string
# in this list, if found as the leading text of the brief description, will be
diff -upr doxygen-1.4.4.vorher/src/config.l doxygen-1.4.4/src/config.l
--- doxygen-1.4.4.vorher/src/config.l 2005-07-03 18:31:22.000000000 +0200
+++ doxygen-1.4.4/src/config.l 2005-08-18 18:35:16.000000000 +0200
@@ -1379,6 +1379,14 @@ void Config::create()
"brief descriptions will be completely suppressed. \n",
TRUE
);
+ cb = addBool(
+ "BRIEF_APPEND_DOT",
+ "If the BRIEF_APPEND_DOT tag is set to YES (the default) Doxygen will append \n"
+ "a dot (\".\") after each brief description. \n"
+ "Note: if OUTPUT_LANGUAGE is set to Chinese, Japanese, or Korean, no dot \n"
+ "will be appended. \n",
+ TRUE
+ );
cl = addList(
"ABBREVIATE_BRIEF",
"This tag implements a quasi-intelligent brief description abbreviator \n"
diff -upr doxygen-1.4.4.vorher/src/definition.cpp doxygen-1.4.4/src/definition.cpp
--- doxygen-1.4.4.vorher/src/definition.cpp 2005-06-19 20:09:34.000000000 +0200
+++ doxygen-1.4.4/src/definition.cpp 2005-08-18 18:23:33.000000000 +0200
@@ -230,7 +230,8 @@ void Definition::setBriefDescription(con
static QCString outputLanguage = Config_getEnum("OUTPUT_LANGUAGE");
static bool needsDot = outputLanguage!="Japanese" &&
outputLanguage!="Chinese" &&
- outputLanguage!="Korean";
+ outputLanguage!="Korean" &&
+ Config_getBool("BRIEF_APPEND_DOT");
//fprintf(stderr,"Definition::setBriefDescription(%s,%s,%d)\n",b,briefFile,briefLine);
m_brief=QCString(b).stripWhiteSpace();