2.2.6.5 release notes
2.2.6.5
- Added support for Markdown text formatting in ApexDoc comments to match the same enhancement to IcApexDoc 1.0.0.5. See the documentation for a description of supported Markdown syntax. A demonstration video is also available. IC2's ApexDoc editor has been enhanced with the following Markdown-specific features:
- Syntax highlighting of Markdown syntax in ApexDoc comments.
- Code completion and references for Markdown hyperlinks to Apex declarations.
- Automatic continuation of block quotes, (un)ordered list items, etc.
- Assistance with list item indent/outdent when Tab and Shift+Tab are used respectively.
- Assistance with backspace when typed in an empty Markdown list item to (try to) adjust the line to the desired state based on its contents.
- Added support for formatting of Markdown tables and (un)ordered lists in ApexDoc comment description text. The following new Apex formatter options are available in the ApexDoc tab Markdown section:
- Format Markdown tables - When enabled, Markdown tables found in the description text of an ApexDoc comment are formatted so that table columns have a consistent width and count. Empty spaces and cells are added as required. This option is enabled by default.
- Format Markdown tables > Spaces within cells - When enabled alongside the option above, a single space is guaranteed around all table cell delimiters. This option is enabled by default.
- Format Markdown lists - When enabled, Markdown lists found in the description text of an ApexDoc comment are formatted so that list items at the same level have consistent indentation relative to one another and to the parent list item based on its list item marker width. This option is enabled by default.
- Format Markdown lists > Distinct ordered list item markers - When enabled alongside the option above, ordered list items markers are numbered in a contiguous, monotonic increasing sequence. Otherwise they all use
1.. This option is enabled by default.
- The ApexDoc code formatter setting for adding
<p/>tags to empty lines is now disabled by default since Markdown processing will automatically add paragraph breaks when empty lines are found.
As stated in the IcApexDoc 1.0.0.5 release notes:
Also note that I discovered a (new to me, at least) REALLY neat trick for editing your ApexDoc comments with a live preview of the rendered result. With the caret in the actual ApexDoc comment, use the Quick documentation keyboard shortcut twice. On Windows and Linux, you would type Ctrl+Q, Ctrl+Q; on Mac you would type F1, F1. That will result in a Documentation tool window being added to the right-hand side of the IDE project window with a tab containing the rendered documentation for the focused ApexDoc comment. Any edits to the ApexDoc comment are reflected in that tab in very close to real-time, hopefully making for quick and pleasant authoring of your ApexDoc content!
"Also note that great care has been taken to try to preserve as close to the same generated HTML output as possible given the same ApexDoc input. In some cases where Markdown(-ish) syntax was already being used for styling, lists, etc., the generated output may actually be improved. However, there are likely some situations where the existing ApexDoc content will need small touch-ups to achieve the desired result." - Fixed an issue where the ApexDoc validator would find and flag issues with references to ApexDoc tags used in content text and not as actual tags.