better format symbols in Android enum property docs

mapbox · Sep 29, 2016 · 1325127 · 1325127
1 parent e08bc5a
commit 1325127
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 16 deletions.
diff --git a/...d/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/PropertyFactory.java b/...d/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/PropertyFactory.java
@@ -52,7 +52,7 @@ public static Property<Function<Boolean>> fillAntialias(Function<Boolean> functi
     }
 
     /**
-     * The opacity of the entire fill layer. In contrast to the `fill-color`, this value will also affect the 1px stroke around the fill, if the stroke is used.
+     * The opacity of the entire fill layer. In contrast to the `fillColor`, this value will also affect the 1px stroke around the fill, if the stroke is used.
      *
      * @param value a Float value
      * @return property wrapper around Float
@@ -62,7 +62,7 @@ public static Property<Float> fillOpacity(Float value) {
     }
 
     /**
-     * The opacity of the entire fill layer. In contrast to the `fill-color`, this value will also affect the 1px stroke around the fill, if the stroke is used.
+     * The opacity of the entire fill layer. In contrast to the `fillColor`, this value will also affect the 1px stroke around the fill, if the stroke is used.
      *
      * @param function a wrapper function for Float
      * @return property wrapper around a Float function
@@ -102,7 +102,7 @@ public static Property<Function<String>> fillColor(Function<String> function) {
     }
 
     /**
-     * The outline color of the fill. Matches the value of `fill-color` if unspecified.
+     * The outline color of the fill. Matches the value of `fillColor` if unspecified.
      *
      * @param value a int color value
      * @return property wrapper around String color
@@ -112,7 +112,7 @@ public static Property<String> fillOutlineColor(@ColorInt int value) {
     }
 
     /**
-     * The outline color of the fill. Matches the value of `fill-color` if unspecified.
+     * The outline color of the fill. Matches the value of `fillColor` if unspecified.
      *
      * @param value a String value
      * @return property wrapper around String
@@ -122,7 +122,7 @@ public static Property<String> fillOutlineColor(String value) {
     }
 
     /**
-     * The outline color of the fill. Matches the value of `fill-color` if unspecified.
+     * The outline color of the fill. Matches the value of `fillColor` if unspecified.
      *
      * @param function a wrapper function for String
      * @return property wrapper around a String function
@@ -1282,7 +1282,7 @@ public static Property<Function<Boolean>> iconOptional(Function<Boolean> functio
     }
 
     /**
-     * In combination with `symbol-placement`, determines the rotation behavior of icons.
+     * In combination with `symbolPlacement`, determines the rotation behavior of icons.
      *
      * @param value a String value
      * @return property wrapper around String
@@ -1292,7 +1292,7 @@ public static Property<String> iconRotationAlignment(@Property.ICON_ROTATION_ALI
     }
 
     /**
-     * In combination with `symbol-placement`, determines the rotation behavior of icons.
+     * In combination with `symbolPlacement`, determines the rotation behavior of icons.
      *
      * @param function a wrapper function for String
      * @return property wrapper around a String function
@@ -1342,7 +1342,7 @@ public static Property<Function<String>> iconTextFit(Function<String> function)
     }
 
     /**
-     * Size of the additional area added to dimensions determined by `icon-text-fix`, in clockwise order: top, right, bottom, left.
+     * Size of the additional area added to dimensions determined by `iconTextFix`, in clockwise order: top, right, bottom, left.
      *
      * @param value a Float[] value
      * @return property wrapper around Float[]
@@ -1352,7 +1352,7 @@ public static Property<Float[]> iconTextFitPadding(Float[] value) {
     }
 
     /**
-     * Size of the additional area added to dimensions determined by `icon-text-fix`, in clockwise order: top, right, bottom, left.
+     * Size of the additional area added to dimensions determined by `iconTextFix`, in clockwise order: top, right, bottom, left.
      *
      * @param function a wrapper function for Float[]
      * @return property wrapper around a Float[] function
@@ -1482,7 +1482,7 @@ public static Property<Function<String>> textPitchAlignment(Function<String> fun
     }
 
     /**
-     * In combination with `symbol-placement`, determines the rotation behavior of the individual glyphs forming the text.
+     * In combination with `symbolPlacement`, determines the rotation behavior of the individual glyphs forming the text.
      *
      * @param value a String value
      * @return property wrapper around String
@@ -1492,7 +1492,7 @@ public static Property<String> textRotationAlignment(@Property.TEXT_ROTATION_ALI
     }
 
     /**
-     * In combination with `symbol-placement`, determines the rotation behavior of the individual glyphs forming the text.
+     * In combination with `symbolPlacement`, determines the rotation behavior of the individual glyphs forming the text.
      *
      * @param function a wrapper function for String
      * @return property wrapper around a String function

diff --git a/...boxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/property_factory.java.ejs b/...boxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/property_factory.java.ejs
@@ -38,7 +38,7 @@ public class PropertyFactory {
 <% for (const property of paintProperties) { -%>
 <% if (property.type == 'color') { -%>
     /**
-     * <%- property.doc %>
+     * <%- propertyDoc(property.name, property) %>
      *
      * @param value a int color value
      * @return property wrapper around String color
@@ -49,7 +49,7 @@ public class PropertyFactory {
 
 <% } -%>
     /**
-     * <%- property.doc %>
+     * <%- propertyDoc(property.name, property) %>
      *
      * @param value a <%- propertyType(property) %> value
      * @return property wrapper around <%- propertyType(property) %>
@@ -59,7 +59,7 @@ public class PropertyFactory {
     }
 
     /**
-     * <%- property.doc %>
+     * <%- propertyDoc(property.name, property) %>
      *
      * @param function a wrapper function for <%- propertyType(property) %>
      * @return property wrapper around a <%- propertyType(property) %> function
@@ -71,7 +71,7 @@ public class PropertyFactory {
 <% } -%>
 <% for (const property of layoutProperties) { -%>
     /**
-     * <%- property.doc %>
+     * <%- propertyDoc(property.name, property) %>
      *
      * @param value a <%- propertyType(property) %> value
      * @return property wrapper around <%- propertyType(property) %>
@@ -81,7 +81,7 @@ public class PropertyFactory {
     }
 
     /**
-     * <%- property.doc %>
+     * <%- propertyDoc(property.name, property) %>
      *
      * @param function a wrapper function for <%- propertyType(property) %>
      * @return property wrapper around a <%- propertyType(property) %> function

diff --git a/platform/android/scripts/generate-style-code.js b/platform/android/scripts/generate-style-code.js
@@ -137,6 +137,16 @@ global.defaultValueJava = function(property) {
       }
 }
 
+global.propertyDoc = function (propertyName, property) {
+    let doc = property.doc.replace(/`(.+?)`/g, function (m, symbol, offset, str) {
+        if (str.substr(offset - 4, 3) !== 'CSS') {
+            symbol = camelizeWithLeadingLowercase(symbol);
+        }
+        return '`' + symbol + '`';
+    });
+    return doc;
+};
+
 //Process Layers
 const layers = Object.keys(spec.layer.type.values).map((type) => {
   const layoutProperties = Object.keys(spec[`layout_${type}`]).reduce((memo, name) => {