Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-2827

Javadoc syntax audit cleanup - product-docs

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Done
    • Neutral
    • None
    • None
    • None
    • None
    • Alex

    Description

      Introduction

      On the back of DOCU-2818 where we wrapped the javadoc syntax with the custom class (inlineBean), orphans have been created in some instances.

      This ticket is to run a clean up looking for those.

      What prompted the ticket?

      Noticed while working on SAASDOCU-3. See attached screenshot.

      What now?

      I'm tackling the example above in SAASDOCU-3, so no need to fix that one. However, we'll need someone to go through with a fine-toothed comb to find other orphans.

      Any tips?

      This regex found the orphans, which will likely work globally.

      (javadoc:) 
      

      – produces 39 results in 28 files currently.

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                mdrapela Martin Drápela
                amansell Alex Mansell
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved: