search

20Tauri / DoxyDoxygen

The last word in code documentation generation
140 stars 5 forks source link

Use both Doxygen syntax and C++ syntax at the same time. #154

Closed zuoya213 closed 3 years ago

zuoya213 commented 3 years ago

Is there any way to use both the Doxygen syntax and C++ syntax at the same time?

image

I need to switch between them to view the doc strings with syntax highlighting and it takes a lot of time.

20Tauri commented 3 years ago

Unfortunately, not easily. Sublimetext allows mixing syntax files, but you will need to create your own "C++" syntax to do this. And remember that doc_styles is a setting... There's no warranty that all C++ users will use Doxygen (QT Doc is an alternative for example). So, it cannot be directly integrated into the main plugin. Another approach is to highlight commands dynamically (using sublime_plugin.EventListener). This approach independent of doc_styles but it requires managing the refresh delay and CPU consumption. It has been experimented with poor results and no plan to integrate it into production yet.

zuoya213 commented 3 years ago

I've tried merging the two syntax files together, however it only shows the C++ syntax. Do you have a way to do it?

20Tauri commented 3 years ago

The previously given link explain how to do the job. SublimeText syntaxes allow to include external file. Remember that, for compatibility reason, Doxydoxygen syntax files use the deprecated TextMate format (may be a problem with some approachs). As syntaxes are part of SublimeText, you probably will have a better support on the SublimeText forum directly.