abap-cleaner icon indicating copy to clipboard operation
abap-cleaner copied to clipboard

Feature request: Make ABAP Doc synchronized if short enough

Open ConjuringCoffee opened this issue 2 years ago • 2 comments

I'd like to request a new rule on automatically making existing ABAP Doc synchronized if the text is short enough.

Example:

"! This is my documentation
CLASS lcl_example DEFINITION CREATE PUBLIC.

  PUBLIC SECTION.
  PROTECTED SECTION.
  PRIVATE SECTION.
ENDCLASS.

Expected result:

"! <p class="shorttext synchronized">This is my documentation</p>
CLASS lcl_example DEFINITION CREATE PUBLIC.

  PUBLIC SECTION.
  PROTECTED SECTION.
  PRIVATE SECTION.
ENDCLASS.

I think this will make writing documentation faster.

The ADT quick fixes sometimes don't generate the ABAP Doc using shorttext synchronized, so that would solve this issue as well.

ConjuringCoffee avatar Jun 06 '23 14:06 ConjuringCoffee

Hi ConjuringCoffee,

that makes sense, you wouldn't want to type <p class="shorttext synchronized"> manually or to copy/paste it from another place. However, let me first try to find out why the Quick fix doesn't always generate this automatically, will get back!

Kind regards, Jörg-Michael

jmgrassau avatar Jun 07 '23 15:06 jmgrassau

Hi @jmgrassau,

have you found out something regarding the quickfix?

Best regards, Alex

alexlukas avatar Feb 29 '24 09:02 alexlukas