summaryrefslogtreecommitdiffstats
path: root/src/commentscan.l
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2019-01-10 12:25:54 (GMT)
committeralbert-github <albert.tests@gmail.com>2019-01-10 12:25:54 (GMT)
commit9ca81a7b0520ffca09818493e861b7710e1efd42 (patch)
tree3d7b17f68691b93ff6894ddec84c0d9065334a77 /src/commentscan.l
parent16f12f29ef44cbab308c2a950bac68c0cd84fdf2 (diff)
downloadDoxygen-9ca81a7b0520ffca09818493e861b7710e1efd42.zip
Doxygen-9ca81a7b0520ffca09818493e861b7710e1efd42.tar.gz
Doxygen-9ca81a7b0520ffca09818493e861b7710e1efd42.tar.bz2
Terminating brief command
The brief command is intended for a small description of a function / class / namespace etc. and not to have extensive formulas or code snippets. These commands should terminate the brief description and start the detailed section. The commands `\snippet` and `\snippetlineno` are added to the list of commands to terminate the brief description. The commands `\f[` and `\f{` are handled separately but now also start a detailed description. The `\f$` is just for small formulas and thus possible in a brief description.
Diffstat (limited to 'src/commentscan.l')
-rw-r--r--src/commentscan.l4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/commentscan.l b/src/commentscan.l
index f9cc3b1..7fab755 100644
--- a/src/commentscan.l
+++ b/src/commentscan.l
@@ -277,6 +277,8 @@ static DocCmdMap docCmdMap[] =
{ "verbinclude", 0, FALSE },
{ "version", 0, TRUE },
{ "warning", 0, TRUE },
+ { "snippet", 0, TRUE },
+ { "snippetlineno", 0, TRUE },
{ 0, 0, FALSE }
};
@@ -1191,6 +1193,7 @@ RCSTAG "$"{ID}":"[^\n$]+"$"
}
}
<Comment>{B}*{CMD}"f{"[^}\n]+"}"("{"?) { // start of a formula with custom environment
+ setOutput(OutputDoc);
formulaText="\\begin";
formulaEnv=QString(yytext).stripWhiteSpace().data()+2;
if (formulaEnv.at(formulaEnv.length()-1)=='{')
@@ -1208,6 +1211,7 @@ RCSTAG "$"{ID}":"[^\n$]+"$"
BEGIN(ReadFormulaShort);
}
<Comment>{B}*{CMD}"f[" { // start of a block formula
+ setOutput(OutputDoc);
formulaText="\\[";
formulaNewLines=0;
BEGIN(ReadFormulaLong);