Spring Roo
  1. Spring Roo
  2. ROO-487

Enhance generated reference guide annexure to incorporate more introspected option help

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.0.0.RC4
    • Fix Version/s: 1.0.0.RELEASE
    • Component/s: @ RESOURCES, @ ROO SHELL
    • Labels:
      None

      Description

      Currently the automatically-generated reference guide appendix A is limited to basic option name and option value help text.

      The present automatically-generated content lacks details of what values are the default if an option is specified or unspecified. It is also slightly unclear to a casual reader how the mandatory options are indicated via the present convention of listing mandatory options beside the command name with non-mandatory options not being listed against the command name but instead being included in the table of option names under the command name. While this latter issue is clarified via the introductory text at the start of the appendix, casual feedback has been that most people jump straight to the relevant command in the appendix and do not read the introductory text.

      The automatic generation algorithm should be improved to make the appendix more usable. The data we need is already there and easily introspected as demonstrated by ROO-389.

        Issue Links

          Activity

          Hide
          Ben Alex added a comment -

          Checked in as SVN revision 539.

          Show
          Ben Alex added a comment - Checked in as SVN revision 539.

            People

            • Assignee:
              Ben Alex
              Reporter:
              Ben Alex
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: