jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix doxygen crash with empty comment

Browse source 
Parsing "/**/" with -doxygen would result in a crash due to
calculation of comment start/end that does not work for an empty
comment.  Fixed by catching this case prior to processing.  Added
simple regression test to doxygen_basic_translate.
This commit is contained in:
John McFarland 2019-10-30 08:15:18 -05:00
commit 0f07a8a08d
2 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

3
Examples/test-suite/doxygen_basic_translate.i
View file

@ -107,6 +107,9 @@ double Atan2(double y, double x)
return 0;
}
/* Regression test for crash with empty comment: */
/**/
/**
* Comment at the end of file should be ignored.
*/

5
Source/CParse/cscanner.c
View file

@ -435,10 +435,11 @@ static int yylook(void) {
if (scan_doxygen_comments) { /* else just skip this node, to avoid crashes in parser module*/
/* Check for all possible Doxygen comment start markers while ignoring
comments starting with a row of asterisks or slashes just as
Doxygen itself does. */
Doxygen itself does. Also skip empty comment (slash-star-star-slash),
which causes a crash due to begin > end. */
if (Len(cmt) > 3 && loc[0] == '/' &&
((loc[1] == '/' && ((loc[2] == '/' && loc[3] != '/') || loc[2] == '!')) ||
(loc[1] == '*' && ((loc[2] == '*' && loc[3] != '*') || loc[2] == '!')))) {
(loc[1] == '*' && ((loc[2] == '*' && loc[3] != '*' && loc[3] != '/') || loc[2] == '!')))) {
comment_kind_t this_comment = loc[3] == '<' ? DOX_COMMENT_POST : DOX_COMMENT_PRE;
if (existing_comment != DOX_COMMENT_NONE && this_comment != existing_comment) {
/* We can't concatenate together Doxygen pre- and post-comments. */