commented unused parameters

that might be needed in subclasses when overriding the methods
eclipse-emf-parsley · Nov 17, 2023 · ada796a · ada796a
1 parent b642640
commit ada796a
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 2 deletions.
diff --git a/...org/eclipse/emf/parsley/dsl/additional/builder/builder/EmfParsleyDslPluginXmlBuilder.java b/...org/eclipse/emf/parsley/dsl/additional/builder/builder/EmfParsleyDslPluginXmlBuilder.java
@@ -109,10 +109,19 @@ protected String loadFromResource(UtilityIFileReader iFileReader, String informa
 		}
 	}
 
+	/**
+	 * @param monitor the progress monitor (unused by default)
+	 * @throws CoreException
+	 */
 	protected void fullBuild(final IProgressMonitor monitor) throws CoreException {
 		getProject().accept(new EmfParsleyDslPluginXmlBuilderResourceVisitor());
 	}
 
+	/**
+	 * @param delta
+	 * @param monitor the progress monitor (unused by default)
+	 * @throws CoreException
+	 */
 	protected void incrementalBuild(IResourceDelta delta,
 			IProgressMonitor monitor) throws CoreException {
 		// the visitor does the work.

diff --git a/....eclipse.emf.parsley.common/src/org/eclipse/emf/parsley/edit/UndoableEditingStrategy.java b/....eclipse.emf.parsley.common/src/org/eclipse/emf/parsley/edit/UndoableEditingStrategy.java
@@ -73,6 +73,9 @@ public void update(EObject edited) {
 		triggerViewerNotification(edited);
 	}
 
+	/**
+	 * @param edited the object being edited
+	 */
 	protected void triggerViewerNotification(EObject edited) {
 		notificationBuffer.propagateBufferedNotifications();
 	}
@@ -83,10 +86,16 @@ public void rollback(EObject edited) {
 		enableNotifications(edited);
 	}
 
+	/**
+	 * @param edited the object being edited
+	 */
 	protected void disableNotifications(EObject edited) {
 		notificationBuffer.startBuffering();
 	}
 
+	/**
+	 * @param edited the object being edited
+	 */
 	protected void enableNotifications(EObject edited) {
 		notificationBuffer.stopBuffering();
 	}

diff --git a/....emf.parsley.common/src/org/eclipse/emf/parsley/ui/provider/TableColumnLabelProvider.java b/....emf.parsley.common/src/org/eclipse/emf/parsley/ui/provider/TableColumnLabelProvider.java
@@ -185,6 +185,7 @@ public Font getFont(Object element) {
 	 * This method will be linked at runtime, belonging to the real input type
 	 * at runtime.
 	 *
+	 * @param element the element for which we return the font
 	 * @return the font for the entire row
 	 */
 	public Font rowFont(Object element) {
@@ -209,6 +210,7 @@ public Color getForeground(Object element) {
 	 * This method will be linked at runtime, belonging to the real input type
 	 * at runtime.
 	 *
+	 * @param element the element for which we return the foreground
 	 * @return the foreground color for the entire row
 	 */
 	public Color rowForeground(Object element) {
@@ -233,6 +235,7 @@ public Color getBackground(Object element) {
 	 * This method will be linked at runtime, belonging to the real input type
 	 * at runtime.
 	 *
+	 * @param element the element for which we return the background
 	 * @return the background color for the entire row
 	 */
 	public Color rowBackground(Object element) {

diff --git a/...lipse.emf.parsley.common/src/org/eclipse/emf/parsley/ui/provider/ViewerLabelProvider.java b/...lipse.emf.parsley.common/src/org/eclipse/emf/parsley/ui/provider/ViewerLabelProvider.java
@@ -141,15 +141,21 @@ public ILabelProvider getDelegateLabelProvider() {
 	}
 
 	/**
-	 * This method will be linked at runtime, belonging to the real input type at runtime.
+	 * This method will be linked at runtime, belonging to the real input type at
+	 * runtime.
+	 *
+	 * @param element the element for which we return the text
 	 * @return the text representation of the input parameter
 	 */
 	public String text(Object element) {
 		return null;
 	}
 
 	/**
-	 * This method will be linked at runtime, belonging to the real input type at runtime.
+	 * This method will be linked at runtime, belonging to the real input type at
+	 * runtime.
+	 *
+	 * @param element the element for which we return the image
 	 * @return the image that represents the input
 	 */
 	public Object image(Object element) {
@@ -205,6 +211,8 @@ public Font getFont(Object element) {
 
 	/**
 	 * This method will be linked at runtime, belonging to the real input type at runtime.
+	 *
+	 * @param element the element for which we return the font
 	 * @return the font that represents the input
 	 */
 	public Font font(Object element) {
@@ -221,6 +229,8 @@ public Color getForeground(Object element) {
 
 	/**
 	 * This method will be linked at runtime, belonging to the real input type at runtime.
+	 *
+	 * @param element the element for which we return the foreground
 	 * @return the foreground color
 	 */
 	public Color foreground(Object element) {
@@ -237,6 +247,8 @@ public Color getBackground(Object element) {
 
 	/**
 	 * This method will be linked at runtime, belonging to the real input type at runtime.
+	 *
+	 * @param element the element for which we return the background
 	 * @return the background color
 	 */
 	public Color background(Object element) {