Author Topic: Update Doc Comment forcing Javadoc regardless of selection  (Read 694 times)

b

  • Senior Community Member
  • Posts: 308
  • Hero Points: 26
Update Doc Comment forcing Javadoc regardless of selection
« on: August 23, 2018, 06:34:29 pm »
Beta2

I've been cleaning up some code and particularly update the comments.  However, Taking a block, right click and Update Doc Comment, selecting Doxygen converts the documentation to Javadoc tags.

Before:
Code: [Select]
/*
 *
 * Function:      vAssertCalled()
 *
 * Input:         pcFile - filename of code where the offending condition occurred.
 *                ulLine - line of code where the offending condition occurred.
 *
 * Output:        None.
 */
void
vAssertCalled(const char * pcFile, unsigned long ulLine)
{
  volatile unsigned long ul = 0;

  (void)pcFile;
  (void)ulLine;
  for(;;);
}

Right click function name, select "Update Doc Comment for vAssertCalled", select *any* option.  The comment format may be correct, but the tags don't match (they *all* use Javadoc, even when "Do not convert style" option is selected.

/*! Doxygen style
(Note the @param, not \param tags)
Looking at the expansion for "/*!", it is correct (factory default).
Also, I'm not sure why its indent is so much (and where is this controlled?)
Code: [Select]
    /*!
     *
     * Function:      vAssertCalled()<br>
     * <br>
     * Input:         pcFile - filename of code where the offending condition occurred.
     *                ulLine - line of code where the offending condition occurred.<br>
     * <br>
     * Output:        None.
     *
     *
     * @param pcFile
     *
     * @param ulLine
     *
     */
...
« Last Edit: August 23, 2018, 06:58:03 pm by b »

Dennis

  • SlickEdit Team Member
  • Senior Community Member
  • *
  • Posts: 2891
  • Hero Points: 436
Re: Update Doc Comment forcing Javadoc regardless of selection
« Reply #1 on: August 23, 2018, 10:33:14 pm »
Reproduced.  Will fix for beta3.

b

  • Senior Community Member
  • Posts: 308
  • Hero Points: 26
Re: Update Doc Comment forcing Javadoc regardless of selection
« Reply #2 on: August 24, 2018, 12:27:59 am »
Looking forward to this!

Is there a configuration for the indentation of the header, or was this a bug?

Dennis

  • SlickEdit Team Member
  • Senior Community Member
  • *
  • Posts: 2891
  • Hero Points: 436
Re: Update Doc Comment forcing Javadoc regardless of selection
« Reply #3 on: August 24, 2018, 02:45:02 pm »
Yes, that was a bug too.  Also fixed for beta3.  As far as I can tell, it only effected comments that were at the beginning of the file.