This discussion is archived
5 Replies Latest reply: Jul 6, 2009 5:09 AM by 843810 RSS

Sorting methods in Method Summary and Method Detail

843810 Newbie
Currently Being Moderated
Hi All,

My javadocs show all my methods in class order in the in Method Summary and Method Detail sections. How can I make them appear in alpha order?
  • 1. Re: Sorting methods in Method Summary and Method Detail
    843810 Newbie
    Currently Being Moderated
    Hi,

    To my best knowledge, you cannot change the sorting order of methods in the Method Summary
    and Method Detail sections of the output generated by the Standard Doclet.
    To customize the sorting order, you would need to change the doclet itself (or develop a different one).
    (However, my Javadoc, e.g. in JDK 6, does sort Method Summary alphabetically.)

    You may also look at this link:

    http://www.filigris.com/products/docflex_javadoc/

    It is a rapid doclet development tool (called DocFlex/Javadoc).
    The actual doclets are designed visually in the form of special templates.
    The default template set is provided that generates the Java API documentation similar to the standard one.

    Using DocFlex/Javadoc, you will be able to customize the standard doclet templates
    and in a few minutes change the method sorting (and anything else).



    Leonid Rudy
    http://www.docflex.com
  • 2. Re: Sorting methods in Method Summary and Method Detail
    843810 Newbie
    Currently Being Moderated
    Thanks Leonid.

    Yes I rebuilt the docs with Java 6 and they are sorted now. I guess this was an added feature. I need to stick with Java 5 for now so I'll definitely look at DocFlex.

    Thanks for the link!
  • 3. Re: Sorting methods in Method Summary and Method Detail
    843810 Newbie
    Currently Being Moderated
    Hi Leonid

    I would like to do the contrary now with the static final public fields. How to make them documented in the order of their definition and not sorted by alphabetic order.

    FA
  • 4. Re: Sorting methods in Method Summary and Method Detail
    thomas.behr Newbie
    Currently Being Moderated
    **sigh**
    Not only did you revive a thread that has been dead for almost a year, you also failed to read said thread properly (as it already contains the answer to your question).

    Let me repeat for the reading challenged among us:
    The Javadoc Standard doclet does not let you customize the order of display. If you need such a feature, either create a custom doclet or find a third-party doclet that can do that.
  • 5. Re: Sorting methods in Method Summary and Method Detail
    843810 Newbie
    Currently Being Moderated
    Hi Leonid

    I would like to do the contrary now with the static final public fields. How to make them documented in the order of their definition and not sorted by alphabetic order.
    Yes, you can do this with DocFlex/Javadoc:

    [http://www.filigris.com/products/docflex_javadoc/]

    But you will need to buy a full license.
    If you are interested in such a solution and don't know what to do next, just send us an email.
    I will explain you everything!
    Please, find the contact info on our website.

    thomas.behr wrote:
    The Javadoc Standard doclet does not let you customize the order of display. If you need such a feature, either create a custom doclet or find a third-party doclet that can do that.
    Yes. That's right!

    Regards,
    Leonid Rudy
    [http://www.docflex.com]