martysama0134 / doxygen-with-highlightjs

HighlightJS for Doxygen

Doxygen Code with syntax highlighting

Based on Doxygen 1.8.13 and HighLightJS 9.11.0

To make the @snippet code be syntax highlighted by highlight.js, there are few steps to do:

1. Generate the default .html templates by doing:

   doxygen.exe -w html header.html footer.html customdoxygen.css

2. Download highlight.js from here specifying which languages you need.

   Inside the zip you will find highlight.pack.js and a list of styles (I'll use style/github.css in this case)

3. Edit header.html adding this before </head>:

   <!--HIGHLIGHT.JS INSTALL BEGIN-->
   <link rel="stylesheet" href="$relpath^github.css">
   <script src="$relpath^highlight.pack.js"></script>
   <script>
   $(function() {
   	hljs.configure({useBR: false});
   	$(".fragment").each(function(i,node) {
   		$(node).removeClass("fragment");
   		hljs.highlightBlock(node);
   	});
   });
   </script>
   <!--HIGHLIGHT.JS INSTALL END-->

4. Edit Doxygen by adding:

   HTML_HEADER            = header.html
   HTML_EXTRA_FILES       = highlight.pack.js github.css

5. Be sure to have all the files checked and it's ready to be compiled.

Result:

1. How you setup a @snippet tag code in source:

   

2. How you setup the real snippet code:

   

3. How it will appear in doxygen: (github.css style)

   

Notes:

1. The inline comments in lua are a little buggy, so I had to use the in-section comments --[[...]] instead.

2. Sometimes, I had to indent the whole code with an extra initial tab/space character to show the initial tags well colored

3. The CDN-hosted of highlightjs packages are here:

   1. highlight.min.js
   2. lua.min.js