fix: bugfix for the mdpopup display for macro doc comments

Author: lexouduck

plugin/error_vis/popups.py

@@ -190,24 +190,25 @@ def info(cursor, cindex, settings):
             popup.__text += Popup.__lookup_in_sublime_index(
                 sublime.active_window(), cursor.spelling)
 
-        raw_comment = None
+        has_comment = None
         if is_macro:
-            raw_comment = macro_parser.doc_string
+            has_comment = macro_parser.doc_string
         else:
-            raw_comment = cursor.raw_comment
+            has_comment = cursor.raw_comment
         # Doxygen comment: single-line brief description
-        if raw_comment and cursor.brief_comment:
+        if cursor.brief_comment or (is_macro and has_comment):
             popup.__text += BRIEF_DOC_TEMPLATE.format(
                 content=CODE_TEMPLATE.format(lang="",
                                              code=cursor.brief_comment))
         # Doxygen comment: multi-line detailed description
-        if raw_comment and cursor.raw_comment:
-            clean_comment = Popup.cleanup_comment(cursor.raw_comment).strip()
+        if cursor.raw_comment or (is_macro and has_comment):
+            clean_comment = Popup.cleanup_comment(has_comment).strip()
             print(clean_comment)
             if clean_comment:
                 # Only add this if there is a Doxygen comment.
                 popup.__text += FULL_DOC_TEMPLATE.format(
                     content=CODE_TEMPLATE.format(lang="", code=clean_comment))
+
         # Show macro body
         if is_macro:
             body = "#define "

plugin/utils/macro_parser.py

@@ -65,7 +65,7 @@ def _parse_macro_file_lines(self, macro_file_lines, macro_line_number):
             if (parser_state != 2) and re.match(r'^\s*//', prevline):
                 parser_state = 1
                 if (re.match(r'^\s*//[/!]', prevline)):
-                    self._raw_comment = prevline + "\n" + self._raw_comment
+                    self._raw_comment = prevline + self._raw_comment
                 else:
                     parser_state = 3
                     log.debug("Error while parsing macro doc comment, " +
@@ -77,17 +77,17 @@ def _parse_macro_file_lines(self, macro_file_lines, macro_line_number):
             if (parser_state == 2):
                 if re.match(r'^\s*/\*', prevline):
                     if re.match(r'^\s*/\*[\*!]', prevline):
-                        self._raw_comment = prevline + "\n" + self._raw_comment
+                        self._raw_comment = prevline + self._raw_comment
                     else:
                         log.debug("Error while parsing macro doc comment, " +
                                   "found normal multi-line comment: " +
                                   self._raw_comment)
                     parser_state = 0 if len(self._raw_comment) == 0 else 3
                 else:
-                    self._raw_comment = prevline + "\n" + self._raw_comment
+                    self._raw_comment = prevline + self._raw_comment
                 continue
             elif re.match(r'^\s*\*/', prevline):
-                self._raw_comment = prevline + "\n" + self._raw_comment
+                self._raw_comment = prevline + self._raw_comment
                 parser_state = 2
                 continue
             if (len(prevline) > 0):
@@ -119,7 +119,7 @@ def _parse_macro_file_lines(self, macro_file_lines, macro_line_number):
         while self._body.endswith("\\"):
             macro_line_number += 1
             line = macro_file_lines[macro_line_number - 1].rstrip()
-            self._body += "\n" + line
+            self._body += line
 
     @property
     def args_string(self):