[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [platform-swt-dev] Platform differences and documentation.

Hi Eric,

In the original bug report (for those interested, https://bugs.eclipse.org/bugs/show_bug.cgi?id=147120 ) I misspoke when I said "platform differences like this" because this was an example of a hint (SWT.FLAT) not being honoured.  Platforms/themes are free to honour or ignore hints like these in order to provide a consistent visual presentation of its choice, and to list all platform/theme decisions like this would be huge and the javadoc would fall out of date as new OS versions/themes became available.

However there is merit to the idea of javadoc'ing some more functional (if that's the right word) differences on a case-by-case basis, such as MenuItems not supporting images on motif.  These will be added to the javadoc rather than the original proposal of having them live in a separate document.


Eric Zimmerman <eric@xxxxxxxxxxx>
Sent by: platform-swt-dev-bounces@xxxxxxxxxxx

06/15/2006 02:26 PM

Please respond to
"Eclipse Platform SWT component developers list." <platform-swt-dev@xxxxxxxxxxx>

"platform-swt-dev@xxxxxxxxxxx" <platform-swt-dev@xxxxxxxxxxx>
[platform-swt-dev] Platform differences and documentation.

I noticed a bug today that had this quote in it from Grant Gayed:

"There is not currently a place where platform differences like this are
listed, but these are being accumulated for a future document/article,
so this has been noted."

Why are platform differences not listed directly in the Javadoc?  This
is where developers go for this type of information.

I agree that a general article that summarizes these differences would
be great for new developers or people evaluating the platform.  However,
static articles don't reflect changes in real time and in contexts that
developers can use while coding.

A wiki with the current information would be a good start, with a long
term goal of javadoc integration.


platform-swt-dev mailing list