Bug 552065 - Add Javadoc to widget factories
Summary: Add Javadoc to widget factories
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 4.14   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 4.14 M3   Edit
Assignee: Jens Lideström CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 550254
  Show dependency tree
 
Reported: 2019-10-13 11:52 EDT by Jens Lideström CLA
Modified: 2019-11-19 04:24 EST (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jens Lideström CLA 2019-10-13 11:52:50 EDT
The widget factories should have adequate Javadoc.

A suitable Javadoc scheme might be this:

* Copy the first sentence from the documentation on the widget setter.
* Copy the documentation of the parameters from the widget setter method.
* Add a link to the widget setter method with the @see Javadoc tag.

Like this:

/**
 * Specify the width of the sashes when the controls in the SashForm are
 * laid out.
 *
 * @param width the width of the sashes
 * @see SashForm#setSashWidth
 */
Comment 1 Eclipse Genie CLA 2019-10-22 04:50:47 EDT
New Gerrit change created: https://git.eclipse.org/r/151422
Comment 3 Lars Vogel CLA 2019-11-04 04:46:34 EST
Jens, is this one fixed? If yes, please update its status and assign to you.
Comment 4 Eclipse Genie CLA 2019-11-10 12:06:41 EST
New Gerrit change created: https://git.eclipse.org/r/152388
Comment 5 Eclipse Genie CLA 2019-11-10 13:04:56 EST
New Gerrit change created: https://git.eclipse.org/r/152391