Fix eclipse warnings and add java documentation, part 2 (#1670)

engine/org.eclipse.birt.report.engine/src/org/eclipse/birt/report/engine/content/ICellContent.java

@@ -45,65 +45,206 @@ public interface ICellContent extends IContainerContent {
 	IColumn getColumnInstance();
 
 	/**
+	 * Get the row
 	 *
-	 * @return
+	 * @return Return the row
 	 */
 	int getRow();
 
+	/**
+	 * Set the column
+	 *
+	 * @param column
+	 */
 	void setColumn(int column);
 
+	/**
+	 * Set the row span
+	 *
+	 * @param rowSpan row span
+	 */
 	void setRowSpan(int rowSpan);
 
+	/**
+	 * Set the column span
+	 *
+	 * @param colSpan column span
+	 */
 	void setColSpan(int colSpan);
 
+	/**
+	 * Set display group icon
+	 *
+	 * @param displayGroupIcon display the group icon
+	 */
 	void setDisplayGroupIcon(boolean displayGroupIcon);
 
+	/**
+	 * Get the display group icon
+	 *
+	 * @return Return the display group icon
+	 */
 	boolean getDisplayGroupIcon();
 
+	/**
+	 * Has diagonal line
+	 *
+	 * @return Return the check of diagonal line
+	 */
 	boolean hasDiagonalLine();
 
+	/**
+	 * Get diagonal number
+	 *
+	 * @return Return the diagonal number
+	 */
 	int getDiagonalNumber();
 
+	/**
+	 * Set diagnonal number
+	 *
+	 * @param diagonalNumber diagonal number
+	 */
 	void setDiagonalNumber(int diagonalNumber);
 
+	/**
+	 * Get diagonal style
+	 *
+	 * @return Return the diagonal style
+	 */
 	String getDiagonalStyle();
 
+	/**
+	 * Set diagonal style
+	 *
+	 * @param diagonalStyle diagonal style
+	 */
 	void setDiagonalStyle(String diagonalStyle);
 
+	/**
+	 * Get the diagonal width
+	 *
+	 * @return Return the diagonal width
+	 */
 	DimensionType getDiagonalWidth();
 
+	/**
+	 * Set the diagonal width
+	 *
+	 * @param diagonalWidth diagonal width
+	 */
 	void setDiagonalWidth(DimensionType diagonalWidth);
 
+	/**
+	 * Get the diagonal color
+	 *
+	 * @return Return the diagonal color
+	 */
 	String getDiagonalColor();
 
+	/**
+	 * Set the diagonal color
+	 *
+	 * @param diagonalColor diagonal color
+	 */
 	void setDiagonalColor(String diagonalColor);
 
+	/**
+	 * Get the anti-diagonal number
+	 *
+	 * @return Return the anti-diagonal number
+	 */
 	int getAntidiagonalNumber();
 
+	/**
+	 * Set the anti-diagonal number
+	 *
+	 * @param antidiagonalNumber anti-diagonal number
+	 */
 	void setAntidiagonalNumber(int antidiagonalNumber);
 
+	/**
+	 * Get the anti-diagonal style
+	 *
+	 * @return Return the anti-diagonal style
+	 */
 	String getAntidiagonalStyle();
 
+	/**
+	 * Set the anti-diagonal style
+	 *
+	 * @param antidiagonalStyle anti-diagonal style
+	 */
 	void setAntidiagonalStyle(String antidiagonalStyle);
 
+	/**
+	 * Get the anti-diagonal width
+	 *
+	 * @return Return the anti-diagonal width
+	 */
 	DimensionType getAntidiagonalWidth();
 
+	/**
+	 * Set the anti-diagonal width
+	 *
+	 * @param antidiagonalWidth anti-diagonal width
+	 */
 	void setAntidiagonalWidth(DimensionType antidiagonalWidth);
 
+	/**
+	 * Get the anti-diagonal color
+	 *
+	 * @return Return the anti-diagonal color
+	 */
 	String getAntidiagonalColor();
 
+	/**
+	 * Set the anti-diagonal color
+	 *
+	 * @param antidiagonalColor anti-diagonal color
+	 */
 	void setAntidiagonalColor(String antidiagonalColor);
 
+	/**
+	 * Get the headers
+	 *
+	 * @return Return the headers
+	 */
 	String getHeaders();
 
+	/**
+	 * Set the headers
+	 *
+	 * @param headers
+	 */
 	void setHeaders(String headers);
 
+	/**
+	 * Get the scope
+	 *
+	 * @return Return the scope
+	 */
 	String getScope();
 
+	/**
+	 * Set the scope
+	 *
+	 * @param scope scope
+	 */
 	void setScope(String scope);
 
+	/**
+	 * Check if the content is repeatable
+	 *
+	 * @return Return the check result if content repeatable
+	 */
 	boolean repeatContent();
 
+	/**
+	 * Set the repeat content
+	 *
+	 * @param repeatContent repeat content
+	 */
 	void setRepeatContent(boolean repeatContent);
 
 }

engine/org.eclipse.birt.report.engine/src/org/eclipse/birt/report/engine/content/IReportContent.java

@@ -61,17 +61,25 @@ public interface IReportContent {
 	/**
 	 * Gets the toc tree of this report content.
 	 *
+	 * @param format
+	 * @param locale
+	 *
 	 * @return the TOC Tree
 	 */
 	ITOCTree getTOCTree(String format, ULocale locale);
 
 	/**
-	 * return root content
+	 * Get the root content
 	 *
-	 * @return
+	 * @return Return the root content
 	 */
 	IContent getRoot();
 
+	/**
+	 * Get the total page
+	 *
+	 * @return Return the total page
+	 */
 	long getTotalPage();
 
 	/**
@@ -142,14 +150,39 @@ public interface IReportContent {
 	 */
 	ITableContent createTableContent();
 
+	/**
+	 * Create the table group content
+	 *
+	 * @return Return the table group content
+	 */
 	ITableGroupContent createTableGroupContent();
 
+	/**
+	 * Create the table band content
+	 *
+	 * @return Return the table band content
+	 */
 	ITableBandContent createTableBandContent();
 
+	/**
+	 * Create the list content
+	 *
+	 * @return Return the list content
+	 */
 	IListContent createListContent();
 
+	/**
+	 * Create the list group content
+	 *
+	 * @return Return the list group content
+	 */
 	IListGroupContent createListGroupContent();
 
+	/**
+	 * Create the list band content
+	 *
+	 * @return Return the list band content
+	 */
 	IListBandContent createListBandContent();
 
 	/**
@@ -173,7 +206,7 @@ public interface IReportContent {
 	 * @param content the content template.
 	 * @return the text content.
 	 */
-	ITextContent createTextContent(IContent conent);
+	ITextContent createTextContent(IContent content);
 
 	/**
 	 * create the foreign content. the foreign content can only be used in this
@@ -197,7 +230,7 @@ public interface IReportContent {
 	 * @param content the content template.
 	 * @return the image content.
 	 */
-	IImageContent createImageContent(IContent conent);
+	IImageContent createImageContent(IContent content);
 
 	/**
 	 * create the label content. the label can only be used in this report.
@@ -220,7 +253,7 @@ public interface IReportContent {
 	 * @param content the content template.
 	 * @return the label content.
 	 */
-	ILabelContent createLabelContent(IContent conent);
+	ILabelContent createLabelContent(IContent content);
 
 	/**
 	 * create the data content. the data can only be used in this report.
@@ -236,10 +269,20 @@ public interface IReportContent {
 	 * @param content the content template.
 	 * @return the data content.
 	 */
-	IDataContent createDataContent(IContent conent);
+	IDataContent createDataContent(IContent content);
 
+	/**
+	 * Get the ACL
+	 *
+	 * @return Return the ACL
+	 */
 	String getACL();
 
+	/**
+	 * Set the ACL
+	 *
+	 * @param acl
+	 */
 	void setACL(String acl);
 
 	/**
@@ -248,16 +291,49 @@ public interface IReportContent {
 	 */
 	IReportContext getReportContext();
 
+	/**
+	 * Get the user properties
+	 *
+	 * @return Return the user properties
+	 */
 	Map<String, Object> getUserProperties();
 
+	/**
+	 * Get the extensions
+	 *
+	 * @return Return the extensions
+	 */
 	Map<String, Object> getExtensions();
 
+	/**
+	 * Set the extensions
+	 *
+	 * @param properties properties of extensions
+	 */
 	void setExtensions(Map<String, Object> properties);
 
+	/**
+	 * Write the content
+	 *
+	 * @param out output stream
+	 * @throws IOException
+	 */
 	void writeContent(DataOutputStream out) throws IOException;
 
+	/**
+	 * Read content
+	 *
+	 * @param in     input stream
+	 * @param loader class loader
+	 * @throws IOException
+	 */
 	void readContent(DataInputStream in, ClassLoader loader) throws IOException;
 
+	/**
+	 * Get the title
+	 *
+	 * @return Return the title
+	 */
 	String getTitle();
 
 	void setTitle(String title);

engine/org.eclipse.birt.report.engine/src/org/eclipse/birt/report/engine/css/dom/AbstractStyle.java

@@ -40,7 +40,7 @@ abstract public class AbstractStyle implements IStyle {
 	protected CSSEngine engine;
 
 	/**
-	 * Consructor
+	 * Constructor
 	 *
 	 * @param engine
 	 */