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

stddoclet: Add links from packages, classes and members to online examples

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Duplicate
    • Icon: P4 P4
    • None
    • 6
    • tools

      Improving the ability to find examples is one of the most highly
      requested features of developers using our website according to
      Sun studies. We can take a giant step toward fixing this for the J2SE
      by adding links to online examples.

      Proposal:
      In javadoc, we add links called "See examples" in three places:

        1) in a package description
        2) in a class description
        3) in a member description

      Not all packages, classes, or member will have a "see examples"
      link -- only ones with examples.

      If you click on a link, you'll see a page that sorta looks like:

        Java Tutorial
           How to blah, blah...
           Looking at blah, blah...
           Finding the blah, blah...
           See all X matches

        Java Almanac
           e423. Quintessential Regular Expression Search Program
           e424. Determining If a String Matches a Pattern Exactly
           e425. Applying Regular Expressions on the Contents of a File
           e426. Removing Duplicate Whitespace in a String
           e427. Greedy and Nongreedy Matching in a Regular Expression
           e428. Escaping Special Characters in a Pattern
           See all X matches

        Tech Tips
           ....
           ....
           See all X matches

            bpatel Bhavesh Patel (Inactive)
            dkramersunw Douglas Kramer (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: