Bug 291579 - Improve warning options section of jdt_api_compile.htm
Summary: Improve warning options section of jdt_api_compile.htm
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 3.6   Edit
Hardware: All All
: P3 trivial (vote)
Target Milestone: 3.6 M3   Edit
Assignee: JDT-Doc-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-10-07 06:06 EDT by Dani Megert CLA
Modified: 2009-10-12 12:21 EDT (History)
2 users (show)

See Also:

Attachments
Defaults column at left (13.56 KB, patch)
2009-10-08 05:02 EDT, Markus Keller CLA 		no flags Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Dani Megert CLA 2009-10-07 06:06:16 EDT 
I20091006-0800.

Some improvements for the Warning options section of jdt_api_compile.htm:

- "Set warning level." could be wrongly interpreted as being able to set the level
  of each problem (e.g. warning, error).
  ==> Specify the set of enabled warnings.
- using red color is not accessible for users with eye problems
  ==> best solution would be to put this into a third table column (see also next
      item)
- it would be better to list the values just once with the description on the 
  right. Currently when I want to check e.g. the red ones I have to search them
  again in the list on the right.
- text "In red are the default settings." could be more accurate:
  ==> "In red are the warnings that are enabled by default.
- "-warn:none                         disable all warnings": description is not
  aligned with the ones below
Comment 1 Olivier Thomann CLA 2009-10-07 12:19:02 EDT 
Released in HEAD.
Daniel, please let me know if this looks better now.
Comment 2 Markus Keller CLA 2009-10-08 05:02:07 EDT 
Created attachment 149098 [details]
Defaults column at left

It's much better than before. But I find "enabled" and "disabled" at the right of the table hard to parse visually. Could we move the column to the left and use "+" and "-" to indicate the defaults?

The patch also contains some tweaks for the explanations above the options table.
Comment 3 Olivier Thomann CLA 2009-10-08 09:17:43 EDT 
Thanks, Markus.
Patch released.
Comment 4 Dani Megert CLA 2009-10-12 12:21:53 EDT 
>Daniel, please let me know if this looks better now.
I like it!