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

Describe or link to useful input formats in API docs

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Fixed
    • Icon: P4 P4
    • 1.4.0
    • 1.2.0
    • docs
    • beta2
    • generic
    • generic



      Name: sg39081 Date: 01/15/99


      I am rapidly getting annoyed by what seems to be
      an unfortunate convention in the API reference:
      whenever a function calls for complex input, there
      is often a note as to what type this input is,
      but nothing about what this input must actually
      consist of.

      An example is Font.getFont(Map attributes)
      which apparantly takes an "attribute set" as
      input. What is this attribute set? What
      attributes does it need to contain to make it
      work? Clicking on the Map icon only gives me the
      class API for Maps, which isn't very useful.

      Similarly, getFont() tells me it gets a font from
      the system property list but doesn't tell me
      what kind of String I might put in there to
      actually get a font (eg, SansSerif - which seems
      to have disappeared under JDK1.2Rc1?)

      It would be really, really nice if you could
      include a description or a link to the
      explanations of these structures in the API
      reference.

      (Review ID: 48290)
      ======================================================================

            sharonz Sharon Zakhour (Inactive)
            sgoodsunw Sheri Good (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: