Attachment 261768 Details for Bug 493745 – Fixing typos and performing minor renamings

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

[patch] Fixing typos and performing minor renamings

493745-fixing-typos-and-performing-minor-renamings.patch (text/plain), 15.52 KB, created by Tamas Miklossy

on 2016-05-16 13:22:58 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Tamas Miklossy

Created: 2016-05-16 13:22:58 EDT

Size: 15.52 KB

patch

obsolete

>diff --git a/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotAttributesTests.java b/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotAttributesTests.java
>index 844015e..7102ca3 100644
>--- a/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotAttributesTests.java
>+++ b/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotAttributesTests.java
>@@ -331,7 +331,7 @@
> 		Edge edge = new Edge.Builder(n1, n2).buildEdge();
> 
> 		// set valid string values
>-		final String validEdgeId = "nodeId";
>+		final String validEdgeId = "edgeId";
> 		DotAttributes.setId(edge, validEdgeId);
> 		assertEquals(validEdgeId, DotAttributes.getId(edge));
> 
>diff --git a/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotExecutableUtilsTests.java b/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotExecutableUtilsTests.java
>index 337e979..238288b 100644
>--- a/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotExecutableUtilsTests.java
>+++ b/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotExecutableUtilsTests.java
>@@ -1,5 +1,5 @@
> /*******************************************************************************
>- * Copyright (c) 2009, 2015 Fabian Steeg, and others.
>+ * Copyright (c) 2009, 2016 itemis AG and others.
>  * 
>  * All rights reserved. This program and the accompanying materials
>  * are made available under the terms of the Eclipse Public License v1.0
>@@ -108,10 +108,6 @@
> 	}
> 
> 	protected void testDotGeneration(final Graph graph, String fileName) {
>-		/*
>-		 * The DotExport class wraps the simple DotTemplate class, so when we
>-		 * test DotExport, we also run the test in the test superclass:
>-		 */
> 		if (dotExecutablePath != null) {
> 			File dotFile = DotFileUtils.write(new DotExport().exportDot(graph));
> 			File image = DotExecutableUtils.renderImage(
>@@ -125,8 +121,8 @@
> 	@Test(timeout = 2000)
> 	public void testComplexDot() throws Exception {
> 		if (dotExecutablePath != null) {
>-			File dotFile = new File(
>-					"./resources/arrowshapes_direction_both.dot");
>+			File dotFile = new File(DotTestUtils.RESOURCES_TESTS
>+					+ "arrowshapes_direction_both.dot");
> 			assertTrue(dotFile.exists());
> 			String[] dotResult = DotExecutableUtils.executeDot(
> 					new File(dotExecutablePath), dotFile, null, null);
>diff --git a/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotExportTests.java b/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotExportTests.java
>index 5b517fe..be30f5f 100644
>--- a/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotExportTests.java
>+++ b/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotExportTests.java
>@@ -1,5 +1,5 @@
> /*******************************************************************************
>- * Copyright (c) 2009, 2016 Fabian Steeg and others.
>+ * Copyright (c) 2009, 2016 itemis AG and others.
>  *
>  * All rights reserved. This program and the accompanying materials
>  * are made available under the terms of the Eclipse Public License v1.0
>@@ -46,10 +46,6 @@
> 	}
> 
> 	protected void testDotGeneration(final Graph graph, String fileName) {
>-		/*
>-		 * The DotExport class wraps the simple DotTemplate class, so when we
>-		 * test DotExport, we also run the test in the test superclass:
>-		 */
> 		String dot = new DotExport().exportDot(graph);
> 		String fileContents = DotFileUtils
> 				.read(new File(RESOURCES_TESTS + fileName));
>diff --git a/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotImportTests.java b/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotImportTests.java
>index 8b96a94..92c23fc 100644
>--- a/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotImportTests.java
>+++ b/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotImportTests.java
>@@ -1,5 +1,6 @@
> /*******************************************************************************
>- * Copyright (c) 2009, 2015 Fabian Steeg and others.
>+ * Copyright (c) 2009, 2016 itemis AG and others.
>+ *
>  * All rights reserved. This program and the accompanying materials
>  * are made available under the terms of the Eclipse Public License v1.0
>  * which accompanies this distribution, and is available at
>@@ -7,6 +8,8 @@
>  *
>  * Contributors:
>  *     Fabian Steeg - initial API and implementation (see bug #277380)
>+ *     Tamas Miklossy  (itemis AG) - implement additional test cases (bug #493136)
>+ *
>  *******************************************************************************/
> package org.eclipse.gef4.dot.tests;
> 
>diff --git a/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotValidatorTests.java b/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotValidatorTests.java
>index e5a8d2f..ade32dd 100644
>--- a/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotValidatorTests.java
>+++ b/org.eclipse.gef4.dot.tests/src/org/eclipse/gef4/dot/tests/DotValidatorTests.java
>@@ -178,6 +178,7 @@
> 				DotPackage.eINSTANCE.getAttribute(), DotAttributes.DIR__E, 29,
> 				3,
> 				"The value 'foo' is not a syntactically correct dirType: Value has to be one of 'forward', 'back', 'both', 'none'.");
>+
> 		// verify that it is the only reported issue
> 		Assert.assertEquals(1, validationTestHelper.validate(dotAst).size());
> 	}
>@@ -229,7 +230,7 @@
> 				DotAttributes.DISTORTION__N,
> 				"The double value '-100.0001' is not semantically correct: Value may not be smaller than -100.0");
> 
>-		// verify that this is the only reported issue
>+		// verify that these are the only reported issues
> 		Assert.assertEquals(2, validationTestHelper.validate(dotAst).size());
> 	}
> 
>@@ -261,7 +262,7 @@
> 				DotPackage.eINSTANCE.getAttribute(), DotAttributes.SIDES__N,
> 				"The int value '-1' is not semantically correct: Value may not be smaller than 0.");
> 
>-		// verify that this is the only reported issue
>+		// verify that these are the only reported issues
> 		Assert.assertEquals(2, validationTestHelper.validate(dotAst).size());
> 	}
> 
>@@ -279,7 +280,7 @@
> 				DotPackage.eINSTANCE.getAttribute(), DotAttributes.SKEW__N,
> 				"The double value '-100.1' is not semantically correct: Value may not be smaller than -100.0");
> 
>-		// verify that this is the only reported issue
>+		// verify that these are the only reported issues
> 		Assert.assertEquals(2, validationTestHelper.validate(dotAst).size());
> 	}
> 
>diff --git a/org.eclipse.gef4.dot.ui/src/org/eclipse/gef4/dot/internal/parser/ui/contentassist/DotProposalProvider.java b/org.eclipse.gef4.dot.ui/src/org/eclipse/gef4/dot/internal/parser/ui/contentassist/DotProposalProvider.java
>index 7f9cb05..ce63325 100644
>--- a/org.eclipse.gef4.dot.ui/src/org/eclipse/gef4/dot/internal/parser/ui/contentassist/DotProposalProvider.java
>+++ b/org.eclipse.gef4.dot.ui/src/org/eclipse/gef4/dot/internal/parser/ui/contentassist/DotProposalProvider.java
>@@ -60,7 +60,7 @@
> 			if (DotJavaValidator.isEdgeAttribute(attribute)
> 					&& DotAttributes.STYLE__GNE.equals(attribute.getName())) {
> 				for (EdgeStyle edgeStyle : EdgeStyle.VALUES) {
>-					// quote attribute value if needed only
>+					// quote attribute value only if needed
> 					final String proposedValue = DotTerminalConverters
> 							.needsToBeQuoted(edgeStyle.toString())
> 									? DotTerminalConverters
>diff --git a/org.eclipse.gef4.dot.ui/src/org/eclipse/gef4/dot/internal/parser/ui/outline/DotOutlineTreeProvider.java b/org.eclipse.gef4.dot.ui/src/org/eclipse/gef4/dot/internal/parser/ui/outline/DotOutlineTreeProvider.java
>index a7965a6..5ac7e00 100644
>--- a/org.eclipse.gef4.dot.ui/src/org/eclipse/gef4/dot/internal/parser/ui/outline/DotOutlineTreeProvider.java
>+++ b/org.eclipse.gef4.dot.ui/src/org/eclipse/gef4/dot/internal/parser/ui/outline/DotOutlineTreeProvider.java
>@@ -1,13 +1,16 @@
> /*******************************************************************************
>- * Copyright (c) 2011,2014 Fabian Steeg. All rights reserved. This program and
>- * the accompanying materials are made available under the terms of the Eclipse
>- * Public License v1.0 which accompanies this distribution, and is available at
>+ * Copyright (c) 2011, 2016 itemis AG and others.
>+ *
>+ * All rights reserved. This program and the accompanying materials
>+ * are made available under the terms of the Eclipse Public License v1.0
>+ * which accompanies this distribution, and is available at
>  * http://www.eclipse.org/legal/epl-v10.html
>- * <p/>
>+ *
>  * Contributors:
>- * Fabian Steeg
>- * - initial API and implementation; see bug 277380
>- * - custom outline labels, icons, and structure; see bug 452650
>+ *     Fabian Steeg               - initial API and implementation (bug #277380)
>+ *                                - custom outline labels, icons, and structure (bug #452650)
>+ *     Tamas Miklossy (itemis AG) - minor renamings (bug #493745)
>+ *
>  *******************************************************************************/
> package org.eclipse.gef4.dot.internal.parser.ui.outline;
> 
>@@ -28,7 +31,7 @@
> 	 * Treat node statements as leafs if they have no attributes.
> 	 * 
> 	 * @param node
>-	 *            The `NodeStmt` model element
>+	 *            The 'NodeStmt' model element
> 	 * @return true if this node contains no attributes
> 	 */
> 	protected boolean _isLeaf(NodeStmt node) {
>@@ -36,10 +39,10 @@
> 	}
> 
> 	/**
>-	 * `EdgeRhs` elements are displayed as leafs and not expandable.
>+	 * 'EdgeRhs' elements are displayed as leafs and not expandable.
> 	 * 
> 	 * @param edge
>-	 *            The `EdgeRhs` model element
>+	 *            The 'EdgeRhs' model element
> 	 * @return true
> 	 */
> 	protected boolean _isLeaf(EdgeRhs edge) {
>@@ -47,7 +50,7 @@
> 	}
> 
> 	/**
>-	 * Skip the `AttrList` wrapper element in the outline structure.
>+	 * Skip the 'AttrList' wrapper element in the outline structure.
> 	 * 
> 	 * @param parent
> 	 *            The outline parent node.
>@@ -57,7 +60,7 @@
> 	protected void _createChildren(IOutlineNode parent, AttrStmt stmt) {
> 		if (stmt.getAttrLists().size() > 0) {
> 			EList<Attribute> attributes = stmt.getAttrLists().get(0)
>-					.getAttributes(); // skip the `AttrList`
>+					.getAttributes(); // skip the 'AttrList'
> 			for (Attribute attribute : attributes) {
> 				createNode(parent, attribute);
> 			}
>diff --git a/org.eclipse.gef4.dot.ui/src/org/eclipse/gef4/dot/internal/parser/ui/syntaxcoloring/DotHighlightingConfiguration.java b/org.eclipse.gef4.dot.ui/src/org/eclipse/gef4/dot/internal/parser/ui/syntaxcoloring/DotHighlightingConfiguration.java
>index 1ea5bb8..4333718 100644
>--- a/org.eclipse.gef4.dot.ui/src/org/eclipse/gef4/dot/internal/parser/ui/syntaxcoloring/DotHighlightingConfiguration.java
>+++ b/org.eclipse.gef4.dot.ui/src/org/eclipse/gef4/dot/internal/parser/ui/syntaxcoloring/DotHighlightingConfiguration.java
>@@ -1,5 +1,5 @@
> /*******************************************************************************
>- * Copyright (c) 2014, 2015 itemis AG and others.
>+ * Copyright (c) 2014, 2016 itemis AG and others.
>  * All rights reserved. This program and the accompanying materials
>  * are made available under the terms of the Eclipse Public License v1.0
>  * which accompanies this distribution, and is available at
>@@ -49,7 +49,7 @@
> 		acceptor.acceptDefaultHighlighting(KEYWORD_ID, "Keyword", //$NON-NLS-1$
> 				keywordTextStyle());
> 
>-		// lexical hightlighting
>+		// lexical highlighting
> 		acceptor.acceptDefaultHighlighting(STRING_ID, "(Unquoted) String", //$NON-NLS-1$
> 				stringTextStyle());
> 		acceptor.acceptDefaultHighlighting(NUMERAL_ID, "Numeral", //$NON-NLS-1$
>diff --git a/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/DotAttributes.java b/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/DotAttributes.java
>index d7d4e1a..bf9d92f 100644
>--- a/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/DotAttributes.java
>+++ b/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/DotAttributes.java
>@@ -179,14 +179,13 @@
> 	public static final String SKEW__N = "skew";
> 
> 	/**
>-	 * Specifies the name of the 'splines' attribute. It is used to control how
>-	 * edges are to be rendered.
>+	 * Specifies the 'splines' attribute of a graph. It is used to control how
>+	 * the edges are to be rendered.
> 	 */
> 	public static final String SPLINES__G = "splines";
> 
> 	/**
>-	 * Specifies the rendering style of an edge, i.e. if it is solid, dashed,
>-	 * dotted, etc.
>+	 * Specifies the 'style' attribute of a graph, node or edge.
> 	 */
> 	public static final String STYLE__GNE = "style";
> 
>@@ -512,7 +511,7 @@
> 	 * 
> 	 * @param node
> 	 *            The {@link Node} for which to return the value of the
>-	 *            {@link #FIXEDSIZE__N} attribute, parsed as a {@link Boolean} .
>+	 *            {@link #FIXEDSIZE__N} attribute, parsed as a {@link Boolean}.
> 	 * @return The value of the {@link #FIXEDSIZE__N} attribute of the given
> 	 *         {@link Node}.
> 	 */
>diff --git a/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/DotInterpreter.java b/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/DotInterpreter.java
>index e29b4ee..67b9ba1 100644
>--- a/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/DotInterpreter.java
>+++ b/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/DotInterpreter.java
>@@ -533,7 +533,7 @@
> 
> 	/**
> 	 * @param stmt
>-	 *            The {@link Stmt} object, e.g. the object corresponding to
>+	 *            The {@link NodeStmt} object, e.g. the object corresponding to
> 	 *            "node[label="hi"]"
> 	 * @param name
> 	 *            The name of the attribute to get the value for, e.g. "label"
>diff --git a/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/DotLanguageSupport.java b/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/DotLanguageSupport.java
>index 4786050..c670572 100644
>--- a/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/DotLanguageSupport.java
>+++ b/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/DotLanguageSupport.java
>@@ -166,7 +166,7 @@
> 	};
> 
> 	/**
>-	 * Parses the given value as a DOT rankdir.
>+	 * A parser used to parse DOT rankdir values.
> 	 */
> 	public static IPrimitiveValueParser<Rankdir> RANKDIR_PARSER = new IPrimitiveValueParser<Rankdir>() {
> 		@Override
>@@ -290,7 +290,7 @@
> 	/**
> 	 * The validator for arrowtype attribute values.
> 	 */
>-	// TODO: move to dotjavaValidator
>+	// TODO: move to DotJavaValidator
> 	public static final DotArrowTypeJavaValidator ARROWTYPE_VALIDATOR = arrowTypeInjector
> 			.getInstance(DotArrowTypeJavaValidator.class);
> 
>@@ -333,7 +333,7 @@
> 	/**
> 	 * The validator for shape attribute values.
> 	 */
>-	// TODO: move to dotjavaValidator
>+	// TODO: move to DotJavaValidator
> 	public static final DotShapeJavaValidator SHAPE_VALIDATOR = shapeInjector
> 			.getInstance(DotShapeJavaValidator.class);
> 
>diff --git a/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/parser/validation/DotJavaValidator.java b/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/parser/validation/DotJavaValidator.java
>index 7c26f19..c02d884 100644
>--- a/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/parser/validation/DotJavaValidator.java
>+++ b/org.eclipse.gef4.dot/src/org/eclipse/gef4/dot/internal/parser/validation/DotJavaValidator.java
>@@ -86,14 +86,17 @@
> 		 * Graph
> 		 */
> 		GRAPH,
>+
> 		/**
> 		 * Subgraph/Cluster
> 		 */
> 		SUBGRAPH,
>+
> 		/**
> 		 * Node
> 		 */
> 		NODE,
>+
> 		/**
> 		 * Edge
> 		 */
>@@ -292,7 +295,7 @@
> 	 */
> 	// TODO: move to DotAttributes
> 	public static boolean isNodeAttribute(Attribute attribute) {
>-		// attribute nested below EdgeStmtNode or EdgeStmtSubgraph
>+		// attribute nested below NodeStmt
> 		if (getAncestorOfType(attribute, NodeStmt.class) != null) {
> 			return true;
> 		}
>@@ -331,7 +334,7 @@
> 	 */
> 	// TODO: move to DotAttributes
> 	public static boolean isGraphAttribute(Attribute attribute) {
>-		// attribute nested below EdgeStmtNode or EdgeStmtSubgraph
>+		// attribute is neither edge nor node nor subgraph attribute
> 		if (isEdgeAttribute(attribute) || isNodeAttribute(attribute)
> 				|| isSubgraphAttribute(attribute)) {
> 			return false;

Flags:

nyssen: iplog+

Actions: View | Diff

Attachments on bug 493745: 261768