Use block comments so IDEA marks usages as deprecated, see phetsims/s…

…cenery-phet#446
phetsims · Mar 5, 2019 · 8b5b334 · 8b5b334
1 parent 1504a72
commit 8b5b334
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/js/SunConstants.js b/js/SunConstants.js
@@ -13,13 +13,17 @@ define( require => {
 
   const SunConstants = {
 
-    // Named placeholder in string patterns where a value will be substituted.
-    // Typically appears in translated strings (e.g. "{{value}} nm") and used with StringUtils.fillIn.
+    /**
+     * Named placeholder in string patterns where a value will be substituted.
+     * Typically appears in translated strings (e.g. "{{value}} nm") and used with StringUtils.fillIn.
+     */
     VALUE_NAMED_PLACEHOLDER: '{{value}}',
 
-    // Numbered placeholder in string patterns where a value will be substituted.
-    // Typically appears in translated strings (e.g. "{0} nm") and used with StringUtils.format.
-    // @deprecated - Named placeholders are the new standard, and numbered placeholders should not be used in new code.
+    /**
+     * Numbered placeholder in string patterns where a value will be substituted.
+     * Typically appears in translated strings (e.g. "{0} nm") and used with StringUtils.format.
+     * @deprecated - Named placeholders are the new standard, and numbered placeholders should not be used in new code.
+     */
     VALUE_NUMBERED_PLACEHOLDER: '{0}',
 
     // Opacity that is typically applied to a UI component in its disabled state, to make it look grayed out.