Skip to content

1.0.0.5

Compare
Choose a tag to compare
@SCWells72 SCWells72 released this 11 May 17:46
· 5 commits to main since this release
  • Issue 6 - IcApexDoc now supports Markdown text formatting (in addition to HTML) in both ApexDoc comments and for overview file contents. For more information, see Markdown support. A demonstration video is also available.
    • Note that @example text is rendered as an Apex fenced code block when no explicit fenced code blocks are found in the example text.
    • 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.
  • Fixed an issue where the top navigation could include dead end links to index pages for missing declaration types.
  • Added generator information to the generated HTML files including the IcApexDoc version and generation date. This is included via the headInclude.vm Velocity template and can be changed or removed as desired.
  • Changed the type of escaping applied during HTML generation from XML 1.1 to HTML 4.0 which likely eliminates a large number of unnecessary escaped entities in HTML, e.g., ' and ", but also may result in proper escapes for some other entities.
  • Generally tightened up vertical whitespace in the generated HTML.