Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8326683

Add JavaDoc option to exclude web fonts from generated documentation

XMLWordPrintable

    • Icon: CSR CSR
    • Resolution: Approved
    • Icon: P3 P3
    • 23
    • tools
    • None
    • behavioral
    • minimal
    • add/remove/modify command line option

      Summary

      Add a JavaDoc option to avoid web fonts being included in generated documentation.

      Problem

      With JDK-8324774, DejaVu web fonts used by the default stylesheet will be included with documentation bundles generated by JavaDoc. While this will improve the consistency of API documentation across browsers and platforms, there are cases in which inclusion of web fonts may not be desirable:

      • Projects that use custom stylesheets which make use of other fonts than the ones used by the default stylesheet.

      • Test environments that invoke javadoc so often that the inclusion of web fonts negatively impacts performance or storage requirements.

      Solution

      Introduce a new JavaDoc option to disable copying of web fonts to the generated documentation bundle.

      Specification

      The following option is added to the Standard JavaDoc doclet:

      --no-fonts
              Do not include standard web fonts in generated documentation

      If the --no-fonts option is specified, JavaDoc will not copy any fonts to the generated documentation bundle, resulting in the same content of the resource-files directory as before JDK-8324774.

      The following text is added to the javadoc tool documentation (man page) in the "Standard Options for the Standard Doclet" section:

      --no-fonts
           Prevents inclusion of font files in the generated documentation. This can
           be useful if the documentation uses a custom stylesheet which does not 
           use the default fonts.

      There are no visible API elements associated with this feature.

            hannesw Hannes Wallnoefer
            hannesw Hannes Wallnoefer
            Jonathan Gibbons, Pavel Rappo
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: