Author Topic: Hitting DEL in doxygen C comment block adds unnecessary */  (Read 400 times)

os2bird

  • Senior Community Member
  • Posts: 110
  • Hero Points: 12
This is a really old problem, but when editing a multiline C-style doxygen comment block (i.e.  /** comment */) and hit delete, sometimes an extra close comment sequence (*/) is appended to the block.

To reproduce:
1. vs +new -sc /tmp/slickcfg-$(uuidgen) /tmp/doxygen-comment-1.cpp
2. Default config, so just hit "finish" in the config wizard.
3. Copy the following into the document:
Code: [Select]
/** @todo Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed
 * do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad
 * minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip... */
4. Place the cursor at the end of the 2nd line (i.e. after "Ut enim ad").
5. Hit the delete key.
6. Result here with 27.0.2.0 (w/ fixes from last week) has an unwanted " */" bit added to it:
Code: [Select]
/** @todo Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed
 * do eiusmod tempor incididunt ut labore et dolore magna
 * aliqua. Ut enim adminim veniam, quis nostrud exercitation
 * ullamco laboris nisi ut aliquip... */ */

Dennis

  • SlickEdit Team Member
  • Senior Community Member
  • *
  • Posts: 3913
  • Hero Points: 513
Re: Hitting DEL in doxygen C comment block adds unnecessary */
« Reply #1 on: May 31, 2023, 02:28:58 PM »
Reproduced.  The doc comment editing seems to expect the closing */ to be on its own line at the end (the stars align).  I'll see if adjustments can be made.

Is this your usual comment style?  I've seen inline comments /**< comment text */ where the close is on the same line, but this style is not typical for multi-line comments.  Does Doxygen handle them correctly?

Dennis

  • SlickEdit Team Member
  • Senior Community Member
  • *
  • Posts: 3913
  • Hero Points: 513
Re: Hitting DEL in doxygen C comment block adds unnecessary */
« Reply #2 on: May 31, 2023, 03:26:34 PM »
This will be fixed in the next rev of the cumulative hot fix.

os2bird

  • Senior Community Member
  • Posts: 110
  • Hero Points: 12
Re: Hitting DEL in doxygen C comment block adds unnecessary */
« Reply #3 on: June 12, 2023, 12:52:07 PM »
The hotfix works. Thanks for the quick response Dennis!

Not having a separate line for the */ bit saves vertical space.  We here find that useful when documenting class/struct members (in header files ++) as it condenses the information, making it a little easier to get an overview.  Doxygen handles it just fine AFAIK.
« Last Edit: June 12, 2023, 12:56:21 PM by os2bird »