Author Topic: V19 javadoc comment skeleton  (Read 3395 times)

jnairb

  • Senior Community Member
  • Posts: 245
  • Hero Points: 11
V19 javadoc comment skeleton
« on: April 03, 2015, 06:32:43 PM »
When I start a javadoc comment for a function with no parameters, the javadoc skeleton includes an empty @param. This didn't happen in VS18.

For example, starting with
Code: [Select]
/**[cursor]*/
void func();

and pressing enter, expands to
Code: [Select]
/**
 *
 * @param 
 */
void func();

Also, for functions that do have parameters, if I use the javadoc-editor to enter a javadoc comment, it aligns the parameter descriptions in the same column normally. The javadoc skeleton that's entered automatically inserts "tab stops" for each parameter description, but they're not aligned. And because of these "tab stops", I can't use tab to move to a common column for my descriptions. Is there any way to get the tab stops aligned after the parameter names?

Clark

  • SlickEdit Team Member
  • Senior Community Member
  • *
  • Posts: 7093
  • Hero Points: 539
Re: V19 javadoc comment skeleton
« Reply #1 on: April 04, 2015, 07:46:31 PM »
Reproduced. We will look into this.

patrick

  • SlickEdit Team Member
  • Senior Community Member
  • *
  • Posts: 1818
  • Hero Points: 151
Re: V19 javadoc comment skeleton
« Reply #2 on: April 06, 2015, 05:48:17 PM »
The problem with the blank @param line should be fixed for the next release candidate.

Those tabs you're seeing are called hotspots.  There's a global on/off for them in the options dialog under Editing -> Hotspots.  If you just don't want them in your comment expansion, you can go to Document -> C++ options in your menu, select "Comments", and then click on the "Edit Expansion" button on the right hand side of the page.  In the javadoc comment, you can remove the "%\c" from the @param line, and you'll no longer get hotspots for your javadoc parameters.

jnairb

  • Senior Community Member
  • Posts: 245
  • Hero Points: 11
Re: V19 javadoc comment skeleton
« Reply #3 on: April 06, 2015, 06:13:09 PM »
I like the hotspots, so I think I'll keep them turned on, but I just wish I could automatically align them.

But I didn't realize I could edit the expansion. I noticed the \%u and \%v escapes and added \%u to the end of the @param line and now it seems to work like it did in v18. But I never created or edited these templates in the past, so something else must have changed in v19.

patrick

  • SlickEdit Team Member
  • Senior Community Member
  • *
  • Posts: 1818
  • Hero Points: 151
Re: V19 javadoc comment skeleton
« Reply #4 on: April 06, 2015, 06:20:23 PM »
Yep, nothing changed on your end, there was a bug in a related fix that was making the parameter line still show up.  % \u makes it work again, but it should't be necessary in this case.  Once rc5 comes out, it should work correctly with or without the %\u.

jnairb

  • Senior Community Member
  • Posts: 245
  • Hero Points: 11
Re: V19 javadoc comment skeleton
« Reply #5 on: April 13, 2015, 02:10:28 PM »
Thanks. It does work for me now without adding the %\u with 19.0.2 RC5.