Uploaded image for project: 'OptaPlanner'
  1. OptaPlanner
  2. PLANNER-2148

Provide Javadoc for config classes and fields to make it available in XSD

XMLWordPrintable

    • 8
    • NEW
    • NEW

      The goal is to make JavaDoc comments available in the XML config in IDEs:

      • provide comments to classes and/or fields annotated with JAXB annotations so that every element of solver config and benchmark config provides valuable documentation
      • the comments should outline the purpose, a default value, and relation to other configuration options where applicable
      • turn on generating documentation on the JAXB maven plugin

            rsynek@redhat.com Radovan Synek
            rsynek@redhat.com Radovan Synek
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: