Derby
  1. Derby
  2. DERBY-4897

Get rid of warning for customized tags in javadoc build

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 10.8.1.2
    • Component/s: Javadoc
    • Labels:
      None

      Description

      Today we see this warning (well, note) in the javadoc build:

      Note: Custom tags that could override future standard tags: @upgrade, @end_format, @disk_layout, @purpose, @format_id. To avoid potential overrides, use at least one period character (.) in custom tag names.

      It would be nice to silence this by doing what's suggested.

      1. derby-4897-1.diff
        40 kB
        Dag H. Wanvik
      2. derby-4897-1.stat
        3 kB
        Dag H. Wanvik
      3. derby-4897-2.diff
        40 kB
        Dag H. Wanvik
      4. derby-4897-2.stat
        3 kB
        Dag H. Wanvik

        Activity

        Hide
        Dag H. Wanvik added a comment -

        Uplaoding a patch that inserts a "." as the first character of the custom tags. This silences the javadoc build warning.

        Show
        Dag H. Wanvik added a comment - Uplaoding a patch that inserts a "." as the first character of the custom tags. This silences the javadoc build warning.
        Hide
        Knut Anders Hatlen added a comment -

        Would it make sense to make the prefix "derby." instead of just "."? The tag "@derby.upgrade" looks less like a typo than "@.upgrade" in my eyes... But the patch does exactly what the note tells us to do, so +1 in any case.

        Show
        Knut Anders Hatlen added a comment - Would it make sense to make the prefix "derby." instead of just "."? The tag "@derby.upgrade" looks less like a typo than "@.upgrade" in my eyes... But the patch does exactly what the note tells us to do, so +1 in any case.
        Hide
        Dag H. Wanvik added a comment -

        I think that's a good idea. It does look like a typo, doesn't it? I'll make that change. Thanks for looking at it, Knut!

        Show
        Dag H. Wanvik added a comment - I think that's a good idea. It does look like a typo, doesn't it? I'll make that change. Thanks for looking at it, Knut!
        Hide
        Dag H. Wanvik added a comment -

        Committed version #2 of the patch as svn 1037009.

        Show
        Dag H. Wanvik added a comment - Committed version #2 of the patch as svn 1037009.

          People

          • Assignee:
            Dag H. Wanvik
            Reporter:
            Dag H. Wanvik
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development