Api docs: use project-vpp-version as defioned in release-notes 08/7808/1
authorMarek Gradzki <[email protected]>
Thu, 27 Jul 2017 06:46:31 +0000 (08:46 +0200)
committerMarek Gradzki <[email protected]>
Thu, 27 Jul 2017 06:46:31 +0000 (08:46 +0200)
Change-Id: I4fb38506dc0090f703a23eb65c0518981929284d
Signed-off-by: Marek Gradzki <[email protected]>
vpp-integration/api-docs/core/src/main/java/io/fd/hc2vpp/docs/core/CoverageGenerator.java
vpp-integration/api-docs/core/src/main/java/io/fd/hc2vpp/docs/core/VppApiUtils.java
vpp-integration/api-docs/scripts/src/main/groovy/io/fd/hc2vpp/docs/scripts/ApiDocsIndexGenerator.groovy

index ff6c9b7..bc94a74 100644 (file)
@@ -54,7 +54,6 @@ public class CoverageGenerator implements VppApiUtils {
     }
 
     public PluginCoverage generateConfigCoverage(final Class<?> pluginClass,
-                                                 final String version,
                                                  final List<Module> scannedModules,
                                                  final YangTypeLinkIndex yangTypeIndex,
                                                  final ClassPathTypeIndex classPathIndex) {
@@ -90,7 +89,7 @@ public class CoverageGenerator implements VppApiUtils {
                             final CoverageUnit.CoverageUnitBuilder builder = new CoverageUnit.CoverageUnitBuilder();
 
                             // binds vpp api name and generateLink bind with version
-                            builder.setVppApi(fromJvppApi(version, jvppMethodName));
+                            builder.setVppApi(fromJvppApi(jvppMethodName));
 
                             //binds java api reference
                             builder.setJavaApi(new JavaApiMessage(jvppMethodName));
index c978aba..d510221 100644 (file)
@@ -22,18 +22,18 @@ import io.fd.hc2vpp.docs.api.VppApiMessage;
 
 public interface VppApiUtils {
 
-    static String generateVppApiDocLink(final String version, final String vppMessageName) {
+    static String generateVppApiDocLink(final String vppMessageName) {
         //https://docs.fd.io/vpp/17.07/d9/d1d/structvl__api__create__subif__t.html
         // links are using double underscore
         //final String doubleUnderscoreApiName = vppApi.replace("_", "__");
         //return format("https://docs.fd.io/vpp/%s/d9/d1d/structvl__api__%s__t.html", version, doubleUnderscoreApiName);
 
         // FIXME - generateLink has dynamic part that can be resolved from api name
-        return "https://docs.fd.io/vpp/17.07/annotated.html";
+        return "https://docs.fd.io/vpp/{project-vpp-version}/annotated.html";
     }
 
-    default VppApiMessage fromJvppApi(final String version, final String jvppMethodName) {
+    default VppApiMessage fromJvppApi(final String jvppMethodName) {
         final String vppMessageName = CaseFormat.LOWER_CAMEL.to(CaseFormat.LOWER_UNDERSCORE, jvppMethodName);
-        return new VppApiMessage(vppMessageName, generateVppApiDocLink(version, vppMessageName));
+        return new VppApiMessage(vppMessageName, generateVppApiDocLink(vppMessageName));
     }
 }
index 99e41ce..ae6ebc6 100644 (file)
@@ -86,7 +86,7 @@ class ApiDocsIndexGenerator {
                 .forEach { pluginClass ->
             log.info "Generating mapping for ${pluginClass}"
             final PluginCoverage configCoverage = new CoverageGenerator()
-                    .generateConfigCoverage(pluginClass, project.version, modules, yangTypeIndex, classPathIndex)
+                    .generateConfigCoverage(pluginClass, modules, yangTypeIndex, classPathIndex)
             generateJvppCoverageDoc(configCoverage, outPath, log)
 
             //TODO operational coverage