How about a table where there is a line of formatted info and then an open box below it with a description. Kind of like (hate ascii art):

+---------+------+-------------------+---------------------------+
| foo.bar | 4096 | no dependencies   | Sets the bar of the foo   |
+---------+------+-------------------+---------------------------+
| This sets the bar for the foo which affects all cases where    |
| we foo the bar and the bar doesn't have its own foo.           |
+----------------------------------------------------------------+

Some options won't require a description or will be batched together with a single description box perhaps...

                        ...jim

On 11/2/2015 1:40 PM, David Hill wrote:
On 11/2/15, 4:27 PM, Jim Graham wrote:
Should we have a column for the default setting?

Also, targetvram shouldn't be set higher unless you also set maxvram
higher - we'll need a place to mention dependent properties.

Should all of that just be mentioned in text in the description field?
Default settings column ..... humm, probably a good idea, though there
is precedence for just stuffing it in the description like we do in
Javadoc.

As much as I have wanted to do this for a while, I guess I have not
thought too much about the format
I was more along the lines of "build it, and they will come" (and
suggest how to do it better). :-)

The challenge of this as I found earlier is that the description is
going to be 95% of the table.

Another way to do this would be to dump the table and do paragraphs with
the flag as the paragraph heading. That *might* flow better.

Any thoughts on that ?

Dave


            ...jim

On 11/2/2015 11:01 AM, David Hill wrote:

Hi all,
    After Jim reminded me (again) with his recent email - I started a
OpenJFX wiki page to note/document the various command line flags we
have that are pretty much only documented in email.

Please take a look at the rather spare page:

https://wiki.openjdk.java.net/display/OpenJFX/Debug+Flags

and either add missing ones in, or send me an email and I will add them.
Corrections are also welcome, I typed this rather quickly.

There are a handful of other ones I know about (mostly font or monocle
related) that are covered in other wiki pages, but should be linked back
at some point.

Dave



Reply via email to