Author Topic: Doxygen comments versus C++ templates  (Read 276 times)

ebbe

  • Community Member
  • Posts: 11
  • Hero Points: 1
Doxygen comments versus C++ templates
« on: May 15, 2019, 10:30:04 am »
When I add a doxygen comment for a function the receives or returns a C++ template type, SE changes the "<" and ">" characters to the equivalent HTML escape sequences, "&lt;" and "&gt;". This makes the comment a lot less readable when looking at the code.

Doxygen handles the "<" and ">" characters in comments just fine, so how do I turn this conversion off?

Clark

  • SlickEdit Team Member
  • Senior Community Member
  • *
  • Posts: 4893
  • Hero Points: 398
Re: Doxygen comments versus C++ templates
« Reply #1 on: May 15, 2019, 04:56:25 pm »
It's not always safe to just generate mytype<whatever>. Try making whatever a valid html tag and you'll notice doxygen fails.

ebbe

  • Community Member
  • Posts: 11
  • Hero Points: 1
Re: Doxygen comments versus C++ templates
« Reply #2 on: May 16, 2019, 08:21:42 am »
There is that. Having looked over the list of tags at https://www.w3schools.com/tags/ I don't think it is that big a risk. And should I ever run into it, SE's refactoring facilities will help me out :).

In my opinion making code comments less readable creates a much bigger risk. But what I really don't like is that it seems that I cannot choose whether SE shall insert HTML escape sequences or not.