Revert "Bug 1672: Generated javadoc contains symbols of javadoc comment tags" 12/29512/1
authorRobert Varga <nite@hq.sk>
Tue, 10 Nov 2015 18:19:50 +0000 (18:19 +0000)
committerRobert Varga <nite@hq.sk>
Tue, 10 Nov 2015 18:19:50 +0000 (18:19 +0000)
This reverts commit 8d273cee83b985508fb231617f3cd23d121d38eb, as it looks like it broke controller.

Change-Id: I679ae4dac8bdf5a838ad8babfcf451958fbda904
Signed-off-by: Robert Varga <rovarga@cisco.com>
binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/yangtools/sal/binding/generator/impl/YangTemplate.xtend
binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/yangtools/sal/java/api/generator/BaseTemplate.xtend
binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/yangtools/sal/java/api/generator/EnumTemplate.xtend
binding/mdsal-binding-java-api-generator/src/test/java/org/opendaylight/yangtools/sal/java/api/generator/test/EndodingInJavaDocTest.java

index 6738a665ddb7a5486a99d5cfb9df067aa33a6941..26d72d831fcd3ff5d649666951f6ba5a0d351a40 100644 (file)
@@ -717,6 +717,7 @@ class YangTemplate {
         var boolean isFirstElementOnNewLineEmptyChar = false;
         val lineIndent = computeNextLineIndent(nextLineIndent);
 
+        formattedText = formattedText.replace("*/", "&#42;&#47;");
         formattedText = NEWLINE_OR_TAB.removeFrom(formattedText);
         formattedText = formattedText.replaceAll(" +", " ");
 
index 3ea37adec35f9878609be7ae2f2f3693db8c660a..d3c2908c81224aaf072c16122e4965b93dd8d1d6 100644 (file)
@@ -213,18 +213,20 @@ abstract class BaseTemplate {
     }
 
     private static final CharMatcher AMP_MATCHER = CharMatcher.is('&');
-    private static final Pattern HTTP_LINK_MATCHER = Pattern.compile("<http(.+)>");
+    private static final CharMatcher GT_MATCHER = CharMatcher.is('>');
+    private static final CharMatcher LT_MATCHER = CharMatcher.is('<');
 
     def encodeJavadocSymbols(String description) {
         if (description.nullOrEmpty) {
             return description;
         }
 
-        // FIXME: Use Guava's HtmlEscapers once we have it available
-        var ret = AMP_MATCHER.replaceFrom(description, "&amp;");
-        ret = HTTP_LINK_MATCHER.matcher(ret).replaceAll("&lt;http$1&gt;");
-        ret = ret.replace("*/", "&#42;&#47;")
+        var ret = description.replace("*/", "&#42;&#47;")
 
+        // FIXME: Use Guava's HtmlEscapers once we have it available
+        ret = AMP_MATCHER.replaceFrom(ret, "&amp;");
+        ret = GT_MATCHER.replaceFrom(ret, "&gt;");
+        ret = LT_MATCHER.replaceFrom(ret, "&lt;");
         return ret;
     }
 
@@ -277,7 +279,7 @@ abstract class BaseTemplate {
         var StringBuilder lineBuilder = new StringBuilder();
         var boolean isFirstElementOnNewLineEmptyChar = false;
 
-        formattedText = encodeJavadocSymbols(formattedText)
+        formattedText = formattedText.encodeJavadocSymbols
         formattedText = NL_MATCHER.removeFrom(formattedText)
         formattedText = TAB_MATCHER.removeFrom(formattedText)
         formattedText = SPACES_PATTERN.matcher(formattedText).replaceAll(" ")
index 7316fa055536ca2d043c6f6d9081ec13629e31df..92466b2bd2b2d7ad8e27360ddca0c982dc860cc6 100644 (file)
@@ -42,7 +42,7 @@ class EnumTemplate extends BaseTemplate {
     }
 
     def writeEnumItem(String name, int value, String description) '''
-        «asJavadoc(description
+        «asJavadoc(formatToParagraph(description)
         «name»(«value»)
     '''
 
index a5170d76f07d1ad0f4c3ceb81be859972860dc5b..330b28e46201e3aeb1afacc7d2f962bf442ed4db 100644 (file)
@@ -1,11 +1,3 @@
-/*
- * Copyright (c) 2015 Cisco Systems, Inc. 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
- */
-
 package org.opendaylight.yangtools.sal.java.api.generator.test;
 
 import static org.junit.Assert.assertTrue;
@@ -15,7 +7,6 @@ import static org.opendaylight.yangtools.sal.java.api.generator.test.Compilation
 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.cleanUp;
 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.getSourceFiles;
 import static org.opendaylight.yangtools.sal.java.api.generator.test.CompilationTestUtils.testCompilation;
-
 import com.google.common.collect.ImmutableSet;
 import java.io.File;
 import java.util.List;
@@ -31,7 +22,7 @@ import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 public class EndodingInJavaDocTest extends BaseCompilationTest {
 
     @Test
-    public void testJavadocEncodingCompilation() throws Exception {
+    public void testAugmentToUsesInAugment() throws Exception {
         final File sourcesOutputDir = new File(GENERATOR_OUTPUT_PATH + FS + "encoding-javadoc");
         assertTrue("Failed to create test file '" + sourcesOutputDir + "'", sourcesOutputDir.mkdir());
         final File compiledOutputDir = new File(COMPILER_OUTPUT_PATH + FS + "encoding-javadoc");