ilib-tools-common 1.2.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -14,6 +14,7 @@
14
14
  <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
15
  <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
16
  <script src="scripts/nav.js" defer></script>
17
+
17
18
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
18
19
  </head>
19
20
  <body>
@@ -27,7 +28,9 @@
27
28
 
28
29
  <nav >
29
30
 
30
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Resource.html">Resource</a><ul class='methods'><li data-type='method'><a href="Resource.html#addInstance">addInstance</a></li><li data-type='method'><a href="Resource.html#escapeText">escapeText</a></li><li data-type='method'><a href="Resource.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="Resource.html#getComment">getComment</a></li><li data-type='method'><a href="Resource.html#getContext">getContext</a></li><li data-type='method'><a href="Resource.html#getDataType">getDataType</a></li><li data-type='method'><a href="Resource.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="Resource.html#getId">getId</a></li><li data-type='method'><a href="Resource.html#getInstances">getInstances</a></li><li data-type='method'><a href="Resource.html#getKey">getKey</a></li><li data-type='method'><a href="Resource.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="Resource.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="Resource.html#getPath">getPath</a></li><li data-type='method'><a href="Resource.html#getProject">getProject</a></li><li data-type='method'><a href="Resource.html#getSource">getSource</a></li><li data-type='method'><a href="Resource.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="Resource.html#getState">getState</a></li><li data-type='method'><a href="Resource.html#getTarget">getTarget</a></li><li data-type='method'><a href="Resource.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="Resource.html#getType">getType</a></li><li data-type='method'><a href="Resource.html#isInstance">isInstance</a></li><li data-type='method'><a href="Resource.html#same">same</a></li><li data-type='method'><a href="Resource.html#setComment">setComment</a></li><li data-type='method'><a href="Resource.html#setProject">setProject</a></li><li data-type='method'><a href="Resource.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="Resource.html#setState">setState</a></li><li data-type='method'><a href="Resource.html#setTargetLocale">setTargetLocale</a></li></ul></li><li><a href="ResourceArray.html">ResourceArray</a><ul class='methods'><li data-type='method'><a href="ResourceArray.html#.hashKey">hashKey</a></li><li data-type='method'><a href="ResourceArray.html#addInstance">addInstance</a></li><li data-type='method'><a href="ResourceArray.html#addSourceItem">addSourceItem</a></li><li data-type='method'><a href="ResourceArray.html#addTargetItem">addTargetItem</a></li><li data-type='method'><a href="ResourceArray.html#cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourceArray.html#cleanHashKeyForTranslation">cleanHashKeyForTranslation</a></li><li data-type='method'><a href="ResourceArray.html#clone">clone</a></li><li data-type='method'><a href="ResourceArray.html#equals">equals</a></li><li data-type='method'><a href="ResourceArray.html#equals">equals</a></li><li data-type='method'><a href="ResourceArray.html#escapeText">escapeText</a></li><li data-type='method'><a href="ResourceArray.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="ResourceArray.html#getComment">getComment</a></li><li data-type='method'><a href="ResourceArray.html#getContext">getContext</a></li><li data-type='method'><a href="ResourceArray.html#getDataType">getDataType</a></li><li data-type='method'><a href="ResourceArray.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="ResourceArray.html#getId">getId</a></li><li data-type='method'><a href="ResourceArray.html#getInstances">getInstances</a></li><li data-type='method'><a href="ResourceArray.html#getKey">getKey</a></li><li data-type='method'><a href="ResourceArray.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="ResourceArray.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="ResourceArray.html#getPath">getPath</a></li><li data-type='method'><a href="ResourceArray.html#getProject">getProject</a></li><li data-type='method'><a href="ResourceArray.html#getSource">getSource</a></li><li data-type='method'><a href="ResourceArray.html#getSourceArray">getSourceArray</a></li><li data-type='method'><a href="ResourceArray.html#getSourceItem">getSourceItem</a></li><li data-type='method'><a href="ResourceArray.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="ResourceArray.html#getState">getState</a></li><li data-type='method'><a href="ResourceArray.html#getTarget">getTarget</a></li><li data-type='method'><a href="ResourceArray.html#getTargetArray">getTargetArray</a></li><li data-type='method'><a href="ResourceArray.html#getTargetItem">getTargetItem</a></li><li data-type='method'><a href="ResourceArray.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="ResourceArray.html#getType">getType</a></li><li data-type='method'><a href="ResourceArray.html#hashKey">hashKey</a></li><li data-type='method'><a href="ResourceArray.html#hashKeyForTranslation">hashKeyForTranslation</a></li><li data-type='method'><a href="ResourceArray.html#isInstance">isInstance</a></li><li data-type='method'><a href="ResourceArray.html#same">same</a></li><li data-type='method'><a href="ResourceArray.html#setComment">setComment</a></li><li data-type='method'><a href="ResourceArray.html#setProject">setProject</a></li><li data-type='method'><a href="ResourceArray.html#setSource">setSource</a></li><li data-type='method'><a href="ResourceArray.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="ResourceArray.html#setState">setState</a></li><li data-type='method'><a href="ResourceArray.html#setTarget">setTarget</a></li><li data-type='method'><a href="ResourceArray.html#setTargetLocale">setTargetLocale</a></li><li data-type='method'><a href="ResourceArray.html#size">size</a></li></ul></li><li><a href="ResourcePlural.html">ResourcePlural</a><ul class='methods'><li data-type='method'><a href="ResourcePlural.html#.hashKey">hashKey</a></li><li data-type='method'><a href="ResourcePlural.html#addInstance">addInstance</a></li><li data-type='method'><a href="ResourcePlural.html#addSourcePlural">addSourcePlural</a></li><li data-type='method'><a href="ResourcePlural.html#addTargetPlural">addTargetPlural</a></li><li data-type='method'><a href="ResourcePlural.html#cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourcePlural.html#cleanHashKeyForTranslation">cleanHashKeyForTranslation</a></li><li data-type='method'><a href="ResourcePlural.html#clone">clone</a></li><li data-type='method'><a href="ResourcePlural.html#equals">equals</a></li><li data-type='method'><a href="ResourcePlural.html#escapeText">escapeText</a></li><li data-type='method'><a href="ResourcePlural.html#getAllValidCategories">getAllValidCategories</a></li><li data-type='method'><a href="ResourcePlural.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="ResourcePlural.html#getCategories">getCategories</a></li><li data-type='method'><a href="ResourcePlural.html#getClasses">getClasses</a></li><li data-type='method'><a href="ResourcePlural.html#getComment">getComment</a></li><li data-type='method'><a href="ResourcePlural.html#getContext">getContext</a></li><li data-type='method'><a href="ResourcePlural.html#getDataType">getDataType</a></li><li data-type='method'><a href="ResourcePlural.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="ResourcePlural.html#getId">getId</a></li><li data-type='method'><a href="ResourcePlural.html#getInstances">getInstances</a></li><li data-type='method'><a href="ResourcePlural.html#getKey">getKey</a></li><li data-type='method'><a href="ResourcePlural.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="ResourcePlural.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="ResourcePlural.html#getPath">getPath</a></li><li data-type='method'><a href="ResourcePlural.html#getProject">getProject</a></li><li data-type='method'><a href="ResourcePlural.html#getSource">getSource</a></li><li data-type='method'><a href="ResourcePlural.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="ResourcePlural.html#getSourcePlural">getSourcePlural</a></li><li data-type='method'><a href="ResourcePlural.html#getSourcePlurals">getSourcePlurals</a></li><li data-type='method'><a href="ResourcePlural.html#getSourceStrings">getSourceStrings</a></li><li data-type='method'><a href="ResourcePlural.html#getState">getState</a></li><li data-type='method'><a href="ResourcePlural.html#getTarget">getTarget</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetPlural">getTargetPlural</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetPlurals">getTargetPlurals</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetStrings">getTargetStrings</a></li><li data-type='method'><a href="ResourcePlural.html#getType">getType</a></li><li data-type='method'><a href="ResourcePlural.html#hashKey">hashKey</a></li><li data-type='method'><a href="ResourcePlural.html#hashKeyForTranslation">hashKeyForTranslation</a></li><li data-type='method'><a href="ResourcePlural.html#isInstance">isInstance</a></li><li data-type='method'><a href="ResourcePlural.html#same">same</a></li><li data-type='method'><a href="ResourcePlural.html#setComment">setComment</a></li><li data-type='method'><a href="ResourcePlural.html#setProject">setProject</a></li><li data-type='method'><a href="ResourcePlural.html#setSource">setSource</a></li><li data-type='method'><a href="ResourcePlural.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="ResourcePlural.html#setState">setState</a></li><li data-type='method'><a href="ResourcePlural.html#setTarget">setTarget</a></li><li data-type='method'><a href="ResourcePlural.html#setTargetLocale">setTargetLocale</a></li><li data-type='method'><a href="ResourcePlural.html#size">size</a></li></ul></li><li><a href="ResourceString.html">ResourceString</a><ul class='methods'><li data-type='method'><a href="ResourceString.html#.cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourceString.html#.hashKey">hashKey</a></li><li data-type='method'><a href="ResourceString.html#addInstance">addInstance</a></li><li data-type='method'><a href="ResourceString.html#cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourceString.html#cleanHashKeyForTranslation">cleanHashKeyForTranslation</a></li><li data-type='method'><a href="ResourceString.html#clone">clone</a></li><li data-type='method'><a href="ResourceString.html#equals">equals</a></li><li data-type='method'><a href="ResourceString.html#escapeText">escapeText</a></li><li data-type='method'><a href="ResourceString.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="ResourceString.html#getComment">getComment</a></li><li data-type='method'><a href="ResourceString.html#getContext">getContext</a></li><li data-type='method'><a href="ResourceString.html#getDataType">getDataType</a></li><li data-type='method'><a href="ResourceString.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="ResourceString.html#getId">getId</a></li><li data-type='method'><a href="ResourceString.html#getInstances">getInstances</a></li><li data-type='method'><a href="ResourceString.html#getKey">getKey</a></li><li data-type='method'><a href="ResourceString.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="ResourceString.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="ResourceString.html#getPath">getPath</a></li><li data-type='method'><a href="ResourceString.html#getProject">getProject</a></li><li data-type='method'><a href="ResourceString.html#getSource">getSource</a></li><li data-type='method'><a href="ResourceString.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="ResourceString.html#getState">getState</a></li><li data-type='method'><a href="ResourceString.html#getTarget">getTarget</a></li><li data-type='method'><a href="ResourceString.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="ResourceString.html#getType">getType</a></li><li data-type='method'><a href="ResourceString.html#hashKey">hashKey</a></li><li data-type='method'><a href="ResourceString.html#hashKeyForTranslation">hashKeyForTranslation</a></li><li data-type='method'><a href="ResourceString.html#isInstance">isInstance</a></li><li data-type='method'><a href="ResourceString.html#same">same</a></li><li data-type='method'><a href="ResourceString.html#setComment">setComment</a></li><li data-type='method'><a href="ResourceString.html#setProject">setProject</a></li><li data-type='method'><a href="ResourceString.html#setSource">setSource</a></li><li data-type='method'><a href="ResourceString.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="ResourceString.html#setState">setState</a></li><li data-type='method'><a href="ResourceString.html#setTarget">setTarget</a></li><li data-type='method'><a href="ResourceString.html#setTargetLocale">setTargetLocale</a></li><li data-type='method'><a href="ResourceString.html#size">size</a></li></ul></li><li><a href="ResourceXliff.html">ResourceXliff</a></li><li><a href="TranslationSet.html">TranslationSet</a><ul class='methods'><li data-type='method'><a href="TranslationSet.html#add">add</a></li><li data-type='method'><a href="TranslationSet.html#addAll">addAll</a></li><li data-type='method'><a href="TranslationSet.html#addSet">addSet</a></li><li data-type='method'><a href="TranslationSet.html#clear">clear</a></li><li data-type='method'><a href="TranslationSet.html#diff">diff</a></li><li data-type='method'><a href="TranslationSet.html#get">get</a></li><li data-type='method'><a href="TranslationSet.html#getAll">getAll</a></li><li data-type='method'><a href="TranslationSet.html#getBy">getBy</a></li><li data-type='method'><a href="TranslationSet.html#getBySource">getBySource</a></li><li data-type='method'><a href="TranslationSet.html#getClean">getClean</a></li><li data-type='method'><a href="TranslationSet.html#getContexts">getContexts</a></li><li data-type='method'><a href="TranslationSet.html#getLocales">getLocales</a></li><li data-type='method'><a href="TranslationSet.html#getProjects">getProjects</a></li><li data-type='method'><a href="TranslationSet.html#isDirty">isDirty</a></li><li data-type='method'><a href="TranslationSet.html#remove">remove</a></li><li data-type='method'><a href="TranslationSet.html#setClean">setClean</a></li><li data-type='method'><a href="TranslationSet.html#size">size</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#cleanString">cleanString</a></li><li><a href="global.html#formatPath">formatPath</a></li><li><a href="global.html#getLocaleFromPath">getLocaleFromPath</a></li><li><a href="global.html#isEmpty">isEmpty</a></li></ul>
31
+
32
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Resource.html">Resource</a><ul class='methods'><li data-type='method'><a href="Resource.html#addInstance">addInstance</a></li><li data-type='method'><a href="Resource.html#escapeText">escapeText</a></li><li data-type='method'><a href="Resource.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="Resource.html#getComment">getComment</a></li><li data-type='method'><a href="Resource.html#getContext">getContext</a></li><li data-type='method'><a href="Resource.html#getDataType">getDataType</a></li><li data-type='method'><a href="Resource.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="Resource.html#getId">getId</a></li><li data-type='method'><a href="Resource.html#getInstances">getInstances</a></li><li data-type='method'><a href="Resource.html#getKey">getKey</a></li><li data-type='method'><a href="Resource.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="Resource.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="Resource.html#getPath">getPath</a></li><li data-type='method'><a href="Resource.html#getProject">getProject</a></li><li data-type='method'><a href="Resource.html#getSource">getSource</a></li><li data-type='method'><a href="Resource.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="Resource.html#getState">getState</a></li><li data-type='method'><a href="Resource.html#getTarget">getTarget</a></li><li data-type='method'><a href="Resource.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="Resource.html#getType">getType</a></li><li data-type='method'><a href="Resource.html#isInstance">isInstance</a></li><li data-type='method'><a href="Resource.html#same">same</a></li><li data-type='method'><a href="Resource.html#setComment">setComment</a></li><li data-type='method'><a href="Resource.html#setProject">setProject</a></li><li data-type='method'><a href="Resource.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="Resource.html#setState">setState</a></li><li data-type='method'><a href="Resource.html#setTargetLocale">setTargetLocale</a></li></ul></li><li><a href="ResourceArray.html">ResourceArray</a><ul class='methods'><li data-type='method'><a href="ResourceArray.html#addInstance">addInstance</a></li><li data-type='method'><a href="ResourceArray.html#addSourceItem">addSourceItem</a></li><li data-type='method'><a href="ResourceArray.html#addTargetItem">addTargetItem</a></li><li data-type='method'><a href="ResourceArray.html#cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourceArray.html#cleanHashKeyForTranslation">cleanHashKeyForTranslation</a></li><li data-type='method'><a href="ResourceArray.html#clone">clone</a></li><li data-type='method'><a href="ResourceArray.html#equals">equals</a></li><li data-type='method'><a href="ResourceArray.html#equals">equals</a></li><li data-type='method'><a href="ResourceArray.html#escapeText">escapeText</a></li><li data-type='method'><a href="ResourceArray.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="ResourceArray.html#getComment">getComment</a></li><li data-type='method'><a href="ResourceArray.html#getContext">getContext</a></li><li data-type='method'><a href="ResourceArray.html#getDataType">getDataType</a></li><li data-type='method'><a href="ResourceArray.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="ResourceArray.html#getId">getId</a></li><li data-type='method'><a href="ResourceArray.html#getInstances">getInstances</a></li><li data-type='method'><a href="ResourceArray.html#getKey">getKey</a></li><li data-type='method'><a href="ResourceArray.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="ResourceArray.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="ResourceArray.html#getPath">getPath</a></li><li data-type='method'><a href="ResourceArray.html#getProject">getProject</a></li><li data-type='method'><a href="ResourceArray.html#getSource">getSource</a></li><li data-type='method'><a href="ResourceArray.html#getSourceArray">getSourceArray</a></li><li data-type='method'><a href="ResourceArray.html#getSourceItem">getSourceItem</a></li><li data-type='method'><a href="ResourceArray.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="ResourceArray.html#getState">getState</a></li><li data-type='method'><a href="ResourceArray.html#getTarget">getTarget</a></li><li data-type='method'><a href="ResourceArray.html#getTargetArray">getTargetArray</a></li><li data-type='method'><a href="ResourceArray.html#getTargetItem">getTargetItem</a></li><li data-type='method'><a href="ResourceArray.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="ResourceArray.html#getType">getType</a></li><li data-type='method'><a href="ResourceArray.html#hashKey">hashKey</a></li><li data-type='method'><a href="ResourceArray.html#hashKeyForTranslation">hashKeyForTranslation</a></li><li data-type='method'><a href="ResourceArray.html#isInstance">isInstance</a></li><li data-type='method'><a href="ResourceArray.html#same">same</a></li><li data-type='method'><a href="ResourceArray.html#setComment">setComment</a></li><li data-type='method'><a href="ResourceArray.html#setProject">setProject</a></li><li data-type='method'><a href="ResourceArray.html#setSource">setSource</a></li><li data-type='method'><a href="ResourceArray.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="ResourceArray.html#setState">setState</a></li><li data-type='method'><a href="ResourceArray.html#setTarget">setTarget</a></li><li data-type='method'><a href="ResourceArray.html#setTargetLocale">setTargetLocale</a></li><li data-type='method'><a href="ResourceArray.html#size">size</a></li><li data-type='method'><a href="ResourceArray.html#.hashKey">hashKey</a></li></ul></li><li><a href="ResourcePlural.html">ResourcePlural</a><ul class='methods'><li data-type='method'><a href="ResourcePlural.html#addInstance">addInstance</a></li><li data-type='method'><a href="ResourcePlural.html#addSourcePlural">addSourcePlural</a></li><li data-type='method'><a href="ResourcePlural.html#addTargetPlural">addTargetPlural</a></li><li data-type='method'><a href="ResourcePlural.html#cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourcePlural.html#cleanHashKeyForTranslation">cleanHashKeyForTranslation</a></li><li data-type='method'><a href="ResourcePlural.html#clone">clone</a></li><li data-type='method'><a href="ResourcePlural.html#equals">equals</a></li><li data-type='method'><a href="ResourcePlural.html#escapeText">escapeText</a></li><li data-type='method'><a href="ResourcePlural.html#getAllValidCategories">getAllValidCategories</a></li><li data-type='method'><a href="ResourcePlural.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="ResourcePlural.html#getCategories">getCategories</a></li><li data-type='method'><a href="ResourcePlural.html#getClasses">getClasses</a></li><li data-type='method'><a href="ResourcePlural.html#getComment">getComment</a></li><li data-type='method'><a href="ResourcePlural.html#getContext">getContext</a></li><li data-type='method'><a href="ResourcePlural.html#getDataType">getDataType</a></li><li data-type='method'><a href="ResourcePlural.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="ResourcePlural.html#getId">getId</a></li><li data-type='method'><a href="ResourcePlural.html#getInstances">getInstances</a></li><li data-type='method'><a href="ResourcePlural.html#getKey">getKey</a></li><li data-type='method'><a href="ResourcePlural.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="ResourcePlural.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="ResourcePlural.html#getPath">getPath</a></li><li data-type='method'><a href="ResourcePlural.html#getProject">getProject</a></li><li data-type='method'><a href="ResourcePlural.html#getSource">getSource</a></li><li data-type='method'><a href="ResourcePlural.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="ResourcePlural.html#getSourcePlural">getSourcePlural</a></li><li data-type='method'><a href="ResourcePlural.html#getSourcePlurals">getSourcePlurals</a></li><li data-type='method'><a href="ResourcePlural.html#getSourceStrings">getSourceStrings</a></li><li data-type='method'><a href="ResourcePlural.html#getState">getState</a></li><li data-type='method'><a href="ResourcePlural.html#getTarget">getTarget</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetPlural">getTargetPlural</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetPlurals">getTargetPlurals</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetStrings">getTargetStrings</a></li><li data-type='method'><a href="ResourcePlural.html#getType">getType</a></li><li data-type='method'><a href="ResourcePlural.html#hashKey">hashKey</a></li><li data-type='method'><a href="ResourcePlural.html#hashKeyForTranslation">hashKeyForTranslation</a></li><li data-type='method'><a href="ResourcePlural.html#isInstance">isInstance</a></li><li data-type='method'><a href="ResourcePlural.html#same">same</a></li><li data-type='method'><a href="ResourcePlural.html#setComment">setComment</a></li><li data-type='method'><a href="ResourcePlural.html#setProject">setProject</a></li><li data-type='method'><a href="ResourcePlural.html#setSource">setSource</a></li><li data-type='method'><a href="ResourcePlural.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="ResourcePlural.html#setState">setState</a></li><li data-type='method'><a href="ResourcePlural.html#setTarget">setTarget</a></li><li data-type='method'><a href="ResourcePlural.html#setTargetLocale">setTargetLocale</a></li><li data-type='method'><a href="ResourcePlural.html#size">size</a></li><li data-type='method'><a href="ResourcePlural.html#.hashKey">hashKey</a></li></ul></li><li><a href="ResourceString.html">ResourceString</a><ul class='methods'><li data-type='method'><a href="ResourceString.html#addInstance">addInstance</a></li><li data-type='method'><a href="ResourceString.html#cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourceString.html#cleanHashKeyForTranslation">cleanHashKeyForTranslation</a></li><li data-type='method'><a href="ResourceString.html#clone">clone</a></li><li data-type='method'><a href="ResourceString.html#equals">equals</a></li><li data-type='method'><a href="ResourceString.html#escapeText">escapeText</a></li><li data-type='method'><a href="ResourceString.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="ResourceString.html#getComment">getComment</a></li><li data-type='method'><a href="ResourceString.html#getContext">getContext</a></li><li data-type='method'><a href="ResourceString.html#getDataType">getDataType</a></li><li data-type='method'><a href="ResourceString.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="ResourceString.html#getId">getId</a></li><li data-type='method'><a href="ResourceString.html#getInstances">getInstances</a></li><li data-type='method'><a href="ResourceString.html#getKey">getKey</a></li><li data-type='method'><a href="ResourceString.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="ResourceString.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="ResourceString.html#getPath">getPath</a></li><li data-type='method'><a href="ResourceString.html#getProject">getProject</a></li><li data-type='method'><a href="ResourceString.html#getSource">getSource</a></li><li data-type='method'><a href="ResourceString.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="ResourceString.html#getState">getState</a></li><li data-type='method'><a href="ResourceString.html#getTarget">getTarget</a></li><li data-type='method'><a href="ResourceString.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="ResourceString.html#getType">getType</a></li><li data-type='method'><a href="ResourceString.html#hashKey">hashKey</a></li><li data-type='method'><a href="ResourceString.html#hashKeyForTranslation">hashKeyForTranslation</a></li><li data-type='method'><a href="ResourceString.html#isInstance">isInstance</a></li><li data-type='method'><a href="ResourceString.html#same">same</a></li><li data-type='method'><a href="ResourceString.html#setComment">setComment</a></li><li data-type='method'><a href="ResourceString.html#setProject">setProject</a></li><li data-type='method'><a href="ResourceString.html#setSource">setSource</a></li><li data-type='method'><a href="ResourceString.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="ResourceString.html#setState">setState</a></li><li data-type='method'><a href="ResourceString.html#setTarget">setTarget</a></li><li data-type='method'><a href="ResourceString.html#setTargetLocale">setTargetLocale</a></li><li data-type='method'><a href="ResourceString.html#size">size</a></li><li data-type='method'><a href="ResourceString.html#.cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourceString.html#.hashKey">hashKey</a></li></ul></li><li><a href="ResourceXliff.html">ResourceXliff</a></li><li><a href="TranslationSet.html">TranslationSet</a><ul class='methods'><li data-type='method'><a href="TranslationSet.html#add">add</a></li><li data-type='method'><a href="TranslationSet.html#addAll">addAll</a></li><li data-type='method'><a href="TranslationSet.html#addSet">addSet</a></li><li data-type='method'><a href="TranslationSet.html#clear">clear</a></li><li data-type='method'><a href="TranslationSet.html#diff">diff</a></li><li data-type='method'><a href="TranslationSet.html#get">get</a></li><li data-type='method'><a href="TranslationSet.html#getAll">getAll</a></li><li data-type='method'><a href="TranslationSet.html#getBy">getBy</a></li><li data-type='method'><a href="TranslationSet.html#getBySource">getBySource</a></li><li data-type='method'><a href="TranslationSet.html#getClean">getClean</a></li><li data-type='method'><a href="TranslationSet.html#getContexts">getContexts</a></li><li data-type='method'><a href="TranslationSet.html#getLocales">getLocales</a></li><li data-type='method'><a href="TranslationSet.html#getProjects">getProjects</a></li><li data-type='method'><a href="TranslationSet.html#isDirty">isDirty</a></li><li data-type='method'><a href="TranslationSet.html#remove">remove</a></li><li data-type='method'><a href="TranslationSet.html#setClean">setClean</a></li><li data-type='method'><a href="TranslationSet.html#size">size</a></li></ul></li><li><a href="TranslationUnit.html">TranslationUnit</a><ul class='methods'><li data-type='method'><a href="TranslationUnit.html#addProperties">addProperties</a></li><li data-type='method'><a href="TranslationUnit.html#addVariant">addVariant</a></li><li data-type='method'><a href="TranslationUnit.html#addVariants">addVariants</a></li><li data-type='method'><a href="TranslationUnit.html#clone">clone</a></li><li data-type='method'><a href="TranslationUnit.html#getProperties">getProperties</a></li><li data-type='method'><a href="TranslationUnit.html#getVariants">getVariants</a></li><li data-type='method'><a href="TranslationUnit.html#hashKey">hashKey</a></li></ul></li><li><a href="TranslationVariant.html">TranslationVariant</a><ul class='methods'><li data-type='method'><a href="TranslationVariant.html#hashKey">hashKey</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#cleanString">cleanString</a></li><li><a href="global.html#containsActualText">containsActualText</a></li><li><a href="global.html#formatPath">formatPath</a></li><li><a href="global.html#getLocaleFromPath">getLocaleFromPath</a></li><li><a href="global.html#hashKey">hashKey</a></li><li><a href="global.html#isEmpty">isEmpty</a></li><li><a href="global.html#objectMap">objectMap</a></li></ul>
33
+
31
34
  </nav>
32
35
 
33
36
  <div id="main">
@@ -45,7 +48,9 @@
45
48
  <header>
46
49
 
47
50
  <h2>
48
- ResourceString
51
+
52
+ ResourceString
53
+
49
54
  </h2>
50
55
 
51
56
  <div class="class-description usertext">Represents a string resource from a resource file or
@@ -72,6 +77,16 @@ extracted from the code.</div>
72
77
 
73
78
 
74
79
  <dl class="details">
80
+
81
+ <dt class="tag-description">Description:</dt>
82
+ <dd class="tag-description"><ul class="dummy"><li>Construct a new ResourceString instance. The props may contain any
83
+ of properties from the Resource constructor and additionally,
84
+ these properties:
85
+
86
+ <ul>
87
+ <li>source {String} - the source string associated with this key
88
+ </ul></li></ul></dd>
89
+
75
90
 
76
91
 
77
92
  <dt class="tag-source">Source:</dt>
@@ -115,18 +130,6 @@ extracted from the code.</div>
115
130
 
116
131
 
117
132
 
118
- <div class="description usertext">
119
- Construct a new ResourceString instance. The props may contain any
120
- of properties from the Resource constructor and additionally,
121
- these properties:
122
-
123
- <ul>
124
- <li>source {String} - the source string associated with this key
125
- </ul>
126
- </div>
127
-
128
-
129
-
130
133
 
131
134
 
132
135
 
@@ -135,7 +138,7 @@ these properties:
135
138
 
136
139
 
137
140
 
138
- <h5>Parameters:</h5>
141
+ <h5 class="h5-parameters">Parameters:</h5>
139
142
 
140
143
 
141
144
  <table class="params">
@@ -169,6 +172,7 @@ these properties:
169
172
  <span class="param-type">Object</span>
170
173
 
171
174
 
175
+
172
176
 
173
177
  </td>
174
178
 
@@ -233,13 +237,17 @@ these properties:
233
237
 
234
238
 
235
239
 
236
- <h4 class="name" id=".resClass"><span class="type-signature">(static, constant) </span>resClass<span class="type-signature"></span></h4>
240
+ <h4 class="name" id=".resClass"><span class="type-signature type-signature-static, constant">(static, constant) </span>resClass<span class="type-signature"></span></h4>
237
241
 
238
242
 
239
243
 
240
244
 
241
245
 
242
246
  <dl class="details">
247
+
248
+ <dt class="tag-description">Description:</dt>
249
+ <dd class="tag-description"><ul class="dummy"><li>The class of this kind of string resource.</li></ul></dd>
250
+
243
251
 
244
252
 
245
253
  <dt class="tag-source">Source:</dt>
@@ -305,7 +313,7 @@ these properties:
305
313
 
306
314
 
307
315
 
308
- <h4 class="name" id=".cleanHashKey"><span class="type-signature">(static) </span>cleanHashKey<span class="signature">(project, locale, reskey, datatype, flavor, context)</span><span class="type-signature"> &rarr; {String}</span></h4>
316
+ <h4 class="name" id="addInstance"><span class="type-signature"></span>addInstance<span class="signature">(an)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
309
317
 
310
318
 
311
319
 
@@ -313,11 +321,45 @@ these properties:
313
321
 
314
322
 
315
323
  <dl class="details">
324
+
325
+ <dt class="tag-description">Description:</dt>
326
+ <dd class="tag-description"><ul class="dummy"><li>Add an instance of the same resource to the list of
327
+ instances. If the given resource matches the
328
+ current instance in all properties that affect the
329
+ possible translation, and differs from the current
330
+ instance by some property that does not affect
331
+ its translation, it will be added as an instance of
332
+ the same string. The following properties affect the
333
+ translation:
334
+
335
+ <ul>
336
+ <li>context</li>
337
+ <li>datatype</li>
338
+ <li>dnt</li>
339
+ <li>flavor</li>
340
+ <li>project</li>
341
+ <li>reskey</li>
342
+ <li>resType</li>
343
+ <li>source</li>
344
+ <li>sourceHash</li>
345
+ <li>sourceArray</li>
346
+ <li>sourceLocale</li>
347
+ <li>targetLocale</li>
348
+ </ul>
349
+
350
+ Differences in other properties, such as "comment" or
351
+ "origin" are considered instances of the same resource.
352
+
353
+ If this method is given a resource that differs from
354
+ the current one by one of the above translation affecting
355
+ properties, it is not added to the list of instances. This
356
+ can be checked easily by calling the isInstance() method.</li></ul></dd>
357
+
316
358
 
317
359
 
318
360
  <dt class="tag-source">Source:</dt>
319
361
  <dd class="tag-source"><ul class="dummy"><li>
320
- <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line151">line 151</a>
362
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line408">line 408</a>
321
363
  </li></ul></dd>
322
364
 
323
365
 
@@ -328,6 +370,11 @@ these properties:
328
370
 
329
371
 
330
372
 
373
+ <dt class="tag-overrides">Overrides:</dt>
374
+ <dd class="tag-overrides"><ul class="dummy"><li>
375
+ <a href="Resource.html#addInstance">Resource#addInstance</a>
376
+ </li></ul></dd>
377
+
331
378
 
332
379
 
333
380
 
@@ -356,13 +403,6 @@ these properties:
356
403
 
357
404
 
358
405
 
359
- <div class="description usertext">
360
- Calculate a resource key string for this class of resource given the
361
- parameters.
362
- </div>
363
-
364
-
365
-
366
406
 
367
407
 
368
408
 
@@ -371,7 +411,7 @@ parameters.
371
411
 
372
412
 
373
413
 
374
- <h5>Parameters:</h5>
414
+ <h5 class="h5-parameters">Parameters:</h5>
375
415
 
376
416
 
377
417
  <table class="params">
@@ -396,13 +436,14 @@ parameters.
396
436
 
397
437
  <tr>
398
438
 
399
- <td class="name"><code>project</code></td>
439
+ <td class="name"><code>an</code></td>
400
440
 
401
441
 
402
442
  <td class="type">
403
443
 
404
444
 
405
- <span class="param-type">String</span>
445
+ <span class="param-type"><a href="Resource.html">Resource</a></span>
446
+
406
447
 
407
448
 
408
449
 
@@ -412,127 +453,117 @@ parameters.
412
453
 
413
454
 
414
455
 
415
- <td class="description last">the project of the string</td>
456
+ <td class="description last">instance of the current resource to
457
+ record</td>
416
458
  </tr>
417
459
 
418
460
 
461
+ </tbody>
462
+ </table>
419
463
 
420
- <tr>
421
-
422
- <td class="name"><code>locale</code></td>
423
-
424
464
 
425
- <td class="type">
426
-
427
-
428
- <span class="param-type">String</span>
429
465
 
430
466
 
431
-
432
- </td>
433
467
 
434
-
435
468
 
436
-
437
469
 
438
- <td class="description last">the locale of the string</td>
439
- </tr>
440
470
 
441
-
442
471
 
443
- <tr>
444
-
445
- <td class="name"><code>reskey</code></td>
446
-
447
472
 
448
- <td class="type">
449
-
450
-
451
- <span class="param-type">String</span>
452
473
 
453
474
 
454
-
455
- </td>
456
475
 
457
-
458
476
 
459
-
460
477
 
461
- <td class="description last">the key of the string</td>
462
- </tr>
478
+
479
+ <h5 class="h5-returns">Returns:</h5>
480
+
481
+
482
+ <div class="param-desc">
483
+ true if the instance was added, and
484
+ and false otherwise
485
+ </div>
486
+
487
+
488
+
489
+ <dl class="param-type">
490
+ <dt>
491
+ Type
492
+ </dt>
493
+ <dd>
494
+
495
+ <span class="param-type">boolean</span>
496
+
497
+
498
+
499
+ </dd>
500
+ </dl>
463
501
 
464
502
 
465
503
 
466
- <tr>
467
-
468
- <td class="name"><code>datatype</code></td>
469
-
470
504
 
471
- <td class="type">
505
+
506
+
472
507
 
473
-
474
- <span class="param-type">String</span>
475
508
 
509
+
476
510
 
477
-
478
- </td>
511
+ <h4 class="name" id="cleanHashKey"><span class="type-signature"></span>cleanHashKey<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
512
+
513
+
479
514
 
480
-
481
515
 
482
-
483
516
 
484
- <td class="description last">the datatype of the string</td>
485
- </tr>
486
517
 
518
+ <dl class="details">
519
+
520
+ <dt class="tag-description">Description:</dt>
521
+ <dd class="tag-description"><ul class="dummy"><li>Return the a hash key that uniquely identifies this resource, but cleaned</li></ul></dd>
487
522
 
488
523
 
489
- <tr>
490
-
491
- <td class="name"><code>flavor</code></td>
492
-
524
+
525
+ <dt class="tag-source">Source:</dt>
526
+ <dd class="tag-source"><ul class="dummy"><li>
527
+ <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line184">line 184</a>
528
+ </li></ul></dd>
529
+
493
530
 
494
- <td class="type">
495
-
496
-
497
- <span class="param-type">String</span>
531
+
498
532
 
533
+
499
534
 
500
-
501
- </td>
535
+
502
536
 
503
-
537
+
504
538
 
505
-
539
+
506
540
 
507
- <td class="description last">the flavor of the string</td>
508
- </tr>
541
+
509
542
 
510
543
 
511
544
 
512
- <tr>
513
-
514
- <td class="name"><code>context</code></td>
515
-
545
+
516
546
 
517
- <td class="type">
518
-
519
-
520
- <span class="param-type">String</span>
547
+
521
548
 
549
+
522
550
 
523
-
524
- </td>
551
+
525
552
 
526
-
553
+
527
554
 
528
-
555
+
529
556
 
530
- <td class="description last">the context of the string</td>
531
- </tr>
557
+
532
558
 
533
559
 
534
- </tbody>
535
- </table>
560
+ </dl>
561
+
562
+
563
+
564
+
565
+
566
+
536
567
 
537
568
 
538
569
 
@@ -549,11 +580,16 @@ parameters.
549
580
 
550
581
 
551
582
 
552
- <h5>Returns:</h5>
583
+
584
+
585
+
586
+
587
+
588
+ <h5 class="h5-returns">Returns:</h5>
553
589
 
554
590
 
555
591
  <div class="param-desc">
556
- a hash key
592
+ a unique hash key for this resource, but cleaned
557
593
  </div>
558
594
 
559
595
 
@@ -567,6 +603,7 @@ parameters.
567
603
  <span class="param-type">String</span>
568
604
 
569
605
 
606
+
570
607
  </dd>
571
608
  </dl>
572
609
 
@@ -579,7 +616,7 @@ parameters.
579
616
 
580
617
 
581
618
 
582
- <h4 class="name" id=".hashKey"><span class="type-signature">(static) </span>hashKey<span class="signature">(project, locale, reskey, datatype, flavor, context)</span><span class="type-signature"> &rarr; {String}</span></h4>
619
+ <h4 class="name" id="cleanHashKeyForTranslation"><span class="type-signature"></span>cleanHashKeyForTranslation<span class="signature">(locale)</span><span class="type-signature"> &rarr; {String}</span></h4>
583
620
 
584
621
 
585
622
 
@@ -587,11 +624,16 @@ parameters.
587
624
 
588
625
 
589
626
  <dl class="details">
627
+
628
+ <dt class="tag-description">Description:</dt>
629
+ <dd class="tag-description"><ul class="dummy"><li>Return the a hash key that uniquely identifies the translation of
630
+ this resource to the given locale, but cleaned</li></ul></dd>
631
+
590
632
 
591
633
 
592
634
  <dt class="tag-source">Source:</dt>
593
635
  <dd class="tag-source"><ul class="dummy"><li>
594
- <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line132">line 132</a>
636
+ <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line196">line 196</a>
595
637
  </li></ul></dd>
596
638
 
597
639
 
@@ -630,13 +672,6 @@ parameters.
630
672
 
631
673
 
632
674
 
633
- <div class="description usertext">
634
- Calculate a resource key string for this class of resource given the
635
- parameters.
636
- </div>
637
-
638
-
639
-
640
675
 
641
676
 
642
677
 
@@ -645,7 +680,7 @@ parameters.
645
680
 
646
681
 
647
682
 
648
- <h5>Parameters:</h5>
683
+ <h5 class="h5-parameters">Parameters:</h5>
649
684
 
650
685
 
651
686
  <table class="params">
@@ -670,7 +705,7 @@ parameters.
670
705
 
671
706
  <tr>
672
707
 
673
- <td class="name"><code>project</code></td>
708
+ <td class="name"><code>locale</code></td>
674
709
 
675
710
 
676
711
  <td class="type">
@@ -679,6 +714,7 @@ parameters.
679
714
  <span class="param-type">String</span>
680
715
 
681
716
 
717
+
682
718
 
683
719
  </td>
684
720
 
@@ -686,127 +722,115 @@ parameters.
686
722
 
687
723
 
688
724
 
689
- <td class="description last">the project of the string</td>
725
+ <td class="description last">a locale spec of the desired translation</td>
690
726
  </tr>
691
727
 
692
728
 
729
+ </tbody>
730
+ </table>
693
731
 
694
- <tr>
695
-
696
- <td class="name"><code>locale</code></td>
697
-
698
732
 
699
- <td class="type">
700
-
701
-
702
- <span class="param-type">String</span>
703
733
 
704
734
 
705
-
706
- </td>
707
735
 
708
-
709
736
 
710
-
711
737
 
712
- <td class="description last">the locale of the string</td>
713
- </tr>
714
738
 
715
-
716
739
 
717
- <tr>
718
-
719
- <td class="name"><code>reskey</code></td>
720
-
721
740
 
722
- <td class="type">
723
-
724
-
725
- <span class="param-type">String</span>
726
741
 
727
742
 
728
-
729
- </td>
730
743
 
731
-
732
744
 
733
-
734
745
 
735
- <td class="description last">the key of the string</td>
736
- </tr>
737
746
 
738
-
747
+ <h5 class="h5-returns">Returns:</h5>
739
748
 
740
- <tr>
741
-
742
- <td class="name"><code>datatype</code></td>
743
-
749
+
750
+ <div class="param-desc">
751
+ a unique hash key for this resource's string
752
+ </div>
744
753
 
745
- <td class="type">
746
-
747
-
754
+
755
+
756
+ <dl class="param-type">
757
+ <dt>
758
+ Type
759
+ </dt>
760
+ <dd>
761
+
748
762
  <span class="param-type">String</span>
749
763
 
750
764
 
751
-
752
- </td>
753
765
 
754
-
766
+ </dd>
767
+ </dl>
768
+
769
+
770
+
755
771
 
772
+
773
+
756
774
 
757
775
 
758
- <td class="description last">the datatype of the string</td>
759
- </tr>
776
+
777
+
778
+ <h4 class="name" id="clone"><span class="type-signature"></span>clone<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="ResourceArray.html">ResourceArray</a>}</span></h4>
760
779
 
761
780
 
762
781
 
763
- <tr>
764
-
765
- <td class="name"><code>flavor</code></td>
766
-
767
782
 
768
- <td class="type">
769
-
770
-
771
- <span class="param-type">String</span>
772
783
 
773
784
 
774
-
775
- </td>
785
+ <dl class="details">
786
+
787
+ <dt class="tag-description">Description:</dt>
788
+ <dd class="tag-description"><ul class="dummy"><li>Clone this resource and override the properties with the given ones.</li></ul></dd>
789
+
776
790
 
777
-
791
+
792
+ <dt class="tag-source">Source:</dt>
793
+ <dd class="tag-source"><ul class="dummy"><li>
794
+ <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line96">line 96</a>
795
+ </li></ul></dd>
796
+
778
797
 
779
-
798
+
780
799
 
781
- <td class="description last">the flavor of the string</td>
782
- </tr>
800
+
783
801
 
784
802
 
785
803
 
786
- <tr>
787
-
788
- <td class="name"><code>context</code></td>
789
-
804
+
790
805
 
791
- <td class="type">
792
-
793
-
794
- <span class="param-type">String</span>
806
+
795
807
 
808
+
796
809
 
797
-
798
- </td>
810
+
799
811
 
800
-
812
+
801
813
 
802
-
814
+
803
815
 
804
- <td class="description last">the context of the string</td>
805
- </tr>
816
+
806
817
 
807
818
 
808
- </tbody>
809
- </table>
819
+
820
+
821
+
822
+
823
+
824
+
825
+
826
+
827
+ </dl>
828
+
829
+
830
+
831
+
832
+
833
+
810
834
 
811
835
 
812
836
 
@@ -823,11 +847,16 @@ parameters.
823
847
 
824
848
 
825
849
 
826
- <h5>Returns:</h5>
850
+
851
+
852
+
853
+
854
+
855
+ <h5 class="h5-returns">Returns:</h5>
827
856
 
828
857
 
829
858
  <div class="param-desc">
830
- a hash key
859
+ a clone of this resource
831
860
  </div>
832
861
 
833
862
 
@@ -838,7 +867,8 @@ parameters.
838
867
  </dt>
839
868
  <dd>
840
869
 
841
- <span class="param-type">String</span>
870
+ <span class="param-type"><a href="ResourceArray.html">ResourceArray</a></span>
871
+
842
872
 
843
873
 
844
874
  </dd>
@@ -853,7 +883,7 @@ parameters.
853
883
 
854
884
 
855
885
 
856
- <h4 class="name" id="addInstance"><span class="type-signature"></span>addInstance<span class="signature">(an)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
886
+ <h4 class="name" id="equals"><span class="type-signature"></span>equals<span class="signature">(other)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
857
887
 
858
888
 
859
889
 
@@ -861,11 +891,16 @@ parameters.
861
891
 
862
892
 
863
893
  <dl class="details">
894
+
895
+ <dt class="tag-description">Description:</dt>
896
+ <dd class="tag-description"><ul class="dummy"><li>Return true if the other resource contains the exact same resource as
897
+ the current one. All fields must match.</li></ul></dd>
898
+
864
899
 
865
900
 
866
901
  <dt class="tag-source">Source:</dt>
867
902
  <dd class="tag-source"><ul class="dummy"><li>
868
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line408">line 408</a>
903
+ <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line113">line 113</a>
869
904
  </li></ul></dd>
870
905
 
871
906
 
@@ -876,11 +911,6 @@ parameters.
876
911
 
877
912
 
878
913
 
879
- <dt class="tag-overrides">Overrides:</dt>
880
- <dd class="tag-overrides"><ul class="dummy"><li>
881
- <a href="Resource.html#addInstance">Resource#addInstance</a>
882
- </li></ul></dd>
883
-
884
914
 
885
915
 
886
916
 
@@ -909,42 +939,6 @@ parameters.
909
939
 
910
940
 
911
941
 
912
- <div class="description usertext">
913
- Add an instance of the same resource to the list of
914
- instances. If the given resource matches the
915
- current instance in all properties that affect the
916
- possible translation, and differs from the current
917
- instance by some property that does not affect
918
- its translation, it will be added as an instance of
919
- the same string. The following properties affect the
920
- translation:
921
-
922
- <ul>
923
- <li>context</li>
924
- <li>datatype</li>
925
- <li>dnt</li>
926
- <li>flavor</li>
927
- <li>project</li>
928
- <li>reskey</li>
929
- <li>resType</li>
930
- <li>source</li>
931
- <li>sourceHash</li>
932
- <li>sourceArray</li>
933
- <li>sourceLocale</li>
934
- <li>targetLocale</li>
935
- </ul>
936
-
937
- Differences in other properties, such as "comment" or
938
- "origin" are considered instances of the same resource.
939
-
940
- If this method is given a resource that differs from
941
- the current one by one of the above translation affecting
942
- properties, it is not added to the list of instances. This
943
- can be checked easily by calling the isInstance() method.
944
- </div>
945
-
946
-
947
-
948
942
 
949
943
 
950
944
 
@@ -953,7 +947,7 @@ can be checked easily by calling the isInstance() method.
953
947
 
954
948
 
955
949
 
956
- <h5>Parameters:</h5>
950
+ <h5 class="h5-parameters">Parameters:</h5>
957
951
 
958
952
 
959
953
  <table class="params">
@@ -978,7 +972,7 @@ can be checked easily by calling the isInstance() method.
978
972
 
979
973
  <tr>
980
974
 
981
- <td class="name"><code>an</code></td>
975
+ <td class="name"><code>other</code></td>
982
976
 
983
977
 
984
978
  <td class="type">
@@ -987,6 +981,7 @@ can be checked easily by calling the isInstance() method.
987
981
  <span class="param-type"><a href="Resource.html">Resource</a></span>
988
982
 
989
983
 
984
+
990
985
 
991
986
  </td>
992
987
 
@@ -994,8 +989,7 @@ can be checked easily by calling the isInstance() method.
994
989
 
995
990
 
996
991
 
997
- <td class="description last">instance of the current resource to
998
- record</td>
992
+ <td class="description last">another resource to test against the current one</td>
999
993
  </tr>
1000
994
 
1001
995
 
@@ -1017,12 +1011,11 @@ record</td>
1017
1011
 
1018
1012
 
1019
1013
 
1020
- <h5>Returns:</h5>
1014
+ <h5 class="h5-returns">Returns:</h5>
1021
1015
 
1022
1016
 
1023
1017
  <div class="param-desc">
1024
- true if the instance was added, and
1025
- and false otherwise
1018
+ true if these represent the same resource, false otherwise
1026
1019
  </div>
1027
1020
 
1028
1021
 
@@ -1036,6 +1029,7 @@ and false otherwise
1036
1029
  <span class="param-type">boolean</span>
1037
1030
 
1038
1031
 
1032
+
1039
1033
  </dd>
1040
1034
  </dl>
1041
1035
 
@@ -1048,7 +1042,7 @@ and false otherwise
1048
1042
 
1049
1043
 
1050
1044
 
1051
- <h4 class="name" id="cleanHashKey"><span class="type-signature"></span>cleanHashKey<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
1045
+ <h4 class="name" id="escapeText"><span class="type-signature"></span>escapeText<span class="signature">(str)</span><span class="type-signature"> &rarr; {String}</span></h4>
1052
1046
 
1053
1047
 
1054
1048
 
@@ -1056,11 +1050,17 @@ and false otherwise
1056
1050
 
1057
1051
 
1058
1052
  <dl class="details">
1053
+
1054
+ <dt class="tag-description">Description:</dt>
1055
+ <dd class="tag-description"><ul class="dummy"><li>Escape text for writing to a database in a SQL command. This puts single
1056
+ quotes around the string, and makes sure that all single quotes within
1057
+ the string are escaped.</li></ul></dd>
1058
+
1059
1059
 
1060
1060
 
1061
1061
  <dt class="tag-source">Source:</dt>
1062
1062
  <dd class="tag-source"><ul class="dummy"><li>
1063
- <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line184">line 184</a>
1063
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line353">line 353</a>
1064
1064
  </li></ul></dd>
1065
1065
 
1066
1066
 
@@ -1071,6 +1071,11 @@ and false otherwise
1071
1071
 
1072
1072
 
1073
1073
 
1074
+ <dt class="tag-overrides">Overrides:</dt>
1075
+ <dd class="tag-overrides"><ul class="dummy"><li>
1076
+ <a href="Resource.html#escapeText">Resource#escapeText</a>
1077
+ </li></ul></dd>
1078
+
1074
1079
 
1075
1080
 
1076
1081
 
@@ -1099,9 +1104,6 @@ and false otherwise
1099
1104
 
1100
1105
 
1101
1106
 
1102
- <div class="description usertext">
1103
- Return the a hash key that uniquely identifies this resource, but cleaned
1104
- </div>
1105
1107
 
1106
1108
 
1107
1109
 
@@ -1110,7 +1112,54 @@ and false otherwise
1110
1112
 
1111
1113
 
1112
1114
 
1115
+ <h5 class="h5-parameters">Parameters:</h5>
1116
+
1117
+
1118
+ <table class="params">
1119
+ <thead>
1120
+ <tr>
1121
+
1122
+ <th>Name</th>
1123
+
1124
+
1125
+ <th>Type</th>
1126
+
1127
+
1128
+
1129
+
1130
+
1131
+ <th class="last">Description</th>
1132
+ </tr>
1133
+ </thead>
1134
+
1135
+ <tbody>
1136
+
1137
+
1138
+ <tr>
1139
+
1140
+ <td class="name"><code>str</code></td>
1141
+
1142
+
1143
+ <td class="type">
1144
+
1145
+
1146
+ <span class="param-type">Object</span>
1147
+
1148
+
1149
+
1150
+
1151
+ </td>
1152
+
1153
+
1154
+
1155
+
1156
+
1157
+ <td class="description last">the item to escape</td>
1158
+ </tr>
1113
1159
 
1160
+
1161
+ </tbody>
1162
+ </table>
1114
1163
 
1115
1164
 
1116
1165
 
@@ -1127,11 +1176,11 @@ and false otherwise
1127
1176
 
1128
1177
 
1129
1178
 
1130
- <h5>Returns:</h5>
1179
+ <h5 class="h5-returns">Returns:</h5>
1131
1180
 
1132
1181
 
1133
1182
  <div class="param-desc">
1134
- a unique hash key for this resource, but cleaned
1183
+ the escaped string
1135
1184
  </div>
1136
1185
 
1137
1186
 
@@ -1145,6 +1194,7 @@ and false otherwise
1145
1194
  <span class="param-type">String</span>
1146
1195
 
1147
1196
 
1197
+
1148
1198
  </dd>
1149
1199
  </dl>
1150
1200
 
@@ -1157,7 +1207,7 @@ and false otherwise
1157
1207
 
1158
1208
 
1159
1209
 
1160
- <h4 class="name" id="cleanHashKeyForTranslation"><span class="type-signature"></span>cleanHashKeyForTranslation<span class="signature">(locale)</span><span class="type-signature"> &rarr; {String}</span></h4>
1210
+ <h4 class="name" id="getAutoKey"><span class="type-signature"></span>getAutoKey<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
1161
1211
 
1162
1212
 
1163
1213
 
@@ -1165,11 +1215,16 @@ and false otherwise
1165
1215
 
1166
1216
 
1167
1217
  <dl class="details">
1218
+
1219
+ <dt class="tag-description">Description:</dt>
1220
+ <dd class="tag-description"><ul class="dummy"><li>Return true if the key of this resource was automatically generated,
1221
+ and false if it was an explicit key.</li></ul></dd>
1222
+
1168
1223
 
1169
1224
 
1170
1225
  <dt class="tag-source">Source:</dt>
1171
1226
  <dd class="tag-source"><ul class="dummy"><li>
1172
- <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line196">line 196</a>
1227
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line165">line 165</a>
1173
1228
  </li></ul></dd>
1174
1229
 
1175
1230
 
@@ -1180,6 +1235,11 @@ and false otherwise
1180
1235
 
1181
1236
 
1182
1237
 
1238
+ <dt class="tag-overrides">Overrides:</dt>
1239
+ <dd class="tag-overrides"><ul class="dummy"><li>
1240
+ <a href="Resource.html#getAutoKey">Resource#getAutoKey</a>
1241
+ </li></ul></dd>
1242
+
1183
1243
 
1184
1244
 
1185
1245
 
@@ -1208,10 +1268,6 @@ and false otherwise
1208
1268
 
1209
1269
 
1210
1270
 
1211
- <div class="description usertext">
1212
- Return the a hash key that uniquely identifies the translation of
1213
- this resource to the given locale, but cleaned
1214
- </div>
1215
1271
 
1216
1272
 
1217
1273
 
@@ -1223,53 +1279,9 @@ this resource to the given locale, but cleaned
1223
1279
 
1224
1280
 
1225
1281
 
1226
- <h5>Parameters:</h5>
1227
-
1228
1282
 
1229
- <table class="params">
1230
- <thead>
1231
- <tr>
1232
-
1233
- <th>Name</th>
1234
-
1235
1283
 
1236
- <th>Type</th>
1237
1284
 
1238
-
1239
-
1240
-
1241
-
1242
- <th class="last">Description</th>
1243
- </tr>
1244
- </thead>
1245
-
1246
- <tbody>
1247
-
1248
-
1249
- <tr>
1250
-
1251
- <td class="name"><code>locale</code></td>
1252
-
1253
-
1254
- <td class="type">
1255
-
1256
-
1257
- <span class="param-type">String</span>
1258
-
1259
-
1260
-
1261
- </td>
1262
-
1263
-
1264
-
1265
-
1266
-
1267
- <td class="description last">a locale spec of the desired translation</td>
1268
- </tr>
1269
-
1270
-
1271
- </tbody>
1272
- </table>
1273
1285
 
1274
1286
 
1275
1287
 
@@ -1278,19 +1290,12 @@ this resource to the given locale, but cleaned
1278
1290
 
1279
1291
 
1280
1292
 
1281
-
1282
-
1283
-
1284
-
1285
-
1286
-
1287
-
1288
-
1289
- <h5>Returns:</h5>
1293
+ <h5 class="h5-returns">Returns:</h5>
1290
1294
 
1291
1295
 
1292
1296
  <div class="param-desc">
1293
- a unique hash key for this resource's string
1297
+ true if the key of this string was auto generated,
1298
+ false otherwise
1294
1299
  </div>
1295
1300
 
1296
1301
 
@@ -1301,7 +1306,8 @@ this resource to the given locale, but cleaned
1301
1306
  </dt>
1302
1307
  <dd>
1303
1308
 
1304
- <span class="param-type">String</span>
1309
+ <span class="param-type">boolean</span>
1310
+
1305
1311
 
1306
1312
 
1307
1313
  </dd>
@@ -1316,7 +1322,7 @@ this resource to the given locale, but cleaned
1316
1322
 
1317
1323
 
1318
1324
 
1319
- <h4 class="name" id="clone"><span class="type-signature"></span>clone<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="ResourceArray.html">ResourceArray</a>}</span></h4>
1325
+ <h4 class="name" id="getComment"><span class="type-signature"></span>getComment<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
1320
1326
 
1321
1327
 
1322
1328
 
@@ -1324,11 +1330,16 @@ this resource to the given locale, but cleaned
1324
1330
 
1325
1331
 
1326
1332
  <dl class="details">
1333
+
1334
+ <dt class="tag-description">Description:</dt>
1335
+ <dd class="tag-description"><ul class="dummy"><li>Return the translator's comment for this resource if there is
1336
+ one, or undefined if not.</li></ul></dd>
1337
+
1327
1338
 
1328
1339
 
1329
1340
  <dt class="tag-source">Source:</dt>
1330
1341
  <dd class="tag-source"><ul class="dummy"><li>
1331
- <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line96">line 96</a>
1342
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line264">line 264</a>
1332
1343
  </li></ul></dd>
1333
1344
 
1334
1345
 
@@ -1339,6 +1350,11 @@ this resource to the given locale, but cleaned
1339
1350
 
1340
1351
 
1341
1352
 
1353
+ <dt class="tag-overrides">Overrides:</dt>
1354
+ <dd class="tag-overrides"><ul class="dummy"><li>
1355
+ <a href="Resource.html#getComment">Resource#getComment</a>
1356
+ </li></ul></dd>
1357
+
1342
1358
 
1343
1359
 
1344
1360
 
@@ -1367,12 +1383,6 @@ this resource to the given locale, but cleaned
1367
1383
 
1368
1384
 
1369
1385
 
1370
- <div class="description usertext">
1371
- Clone this resource and override the properties with the given ones.
1372
- </div>
1373
-
1374
-
1375
-
1376
1386
 
1377
1387
 
1378
1388
 
@@ -1395,11 +1405,12 @@ this resource to the given locale, but cleaned
1395
1405
 
1396
1406
 
1397
1407
 
1398
- <h5>Returns:</h5>
1408
+ <h5 class="h5-returns">Returns:</h5>
1399
1409
 
1400
1410
 
1401
1411
  <div class="param-desc">
1402
- a clone of this resource
1412
+ the translator's comment for this resource
1413
+ if the engineer put one in the code
1403
1414
  </div>
1404
1415
 
1405
1416
 
@@ -1410,7 +1421,11 @@ this resource to the given locale, but cleaned
1410
1421
  </dt>
1411
1422
  <dd>
1412
1423
 
1413
- <span class="param-type"><a href="ResourceArray.html">ResourceArray</a></span>
1424
+ <span class="param-type">String</span>
1425
+ |
1426
+
1427
+ <span class="param-type">undefined</span>
1428
+
1414
1429
 
1415
1430
 
1416
1431
  </dd>
@@ -1425,7 +1440,7 @@ this resource to the given locale, but cleaned
1425
1440
 
1426
1441
 
1427
1442
 
1428
- <h4 class="name" id="equals"><span class="type-signature"></span>equals<span class="signature">(other)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
1443
+ <h4 class="name" id="getContext"><span class="type-signature"></span>getContext<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
1429
1444
 
1430
1445
 
1431
1446
 
@@ -1433,11 +1448,16 @@ this resource to the given locale, but cleaned
1433
1448
 
1434
1449
 
1435
1450
  <dl class="details">
1451
+
1452
+ <dt class="tag-description">Description:</dt>
1453
+ <dd class="tag-description"><ul class="dummy"><li>Return the context of this resource, or undefined if there
1454
+ is no context.</li></ul></dd>
1455
+
1436
1456
 
1437
1457
 
1438
1458
  <dt class="tag-source">Source:</dt>
1439
1459
  <dd class="tag-source"><ul class="dummy"><li>
1440
- <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line113">line 113</a>
1460
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line175">line 175</a>
1441
1461
  </li></ul></dd>
1442
1462
 
1443
1463
 
@@ -1448,7 +1468,10 @@ this resource to the given locale, but cleaned
1448
1468
 
1449
1469
 
1450
1470
 
1451
-
1471
+ <dt class="tag-overrides">Overrides:</dt>
1472
+ <dd class="tag-overrides"><ul class="dummy"><li>
1473
+ <a href="Resource.html#getContext">Resource#getContext</a>
1474
+ </li></ul></dd>
1452
1475
 
1453
1476
 
1454
1477
 
@@ -1470,74 +1493,20 @@ this resource to the given locale, but cleaned
1470
1493
 
1471
1494
 
1472
1495
 
1473
- </dl>
1474
-
1475
-
1476
-
1477
-
1478
-
1479
- <div class="description usertext">
1480
- Return true if the other resource contains the exact same resource as
1481
- the current one. All fields must match.
1482
- </div>
1483
-
1484
-
1485
-
1486
-
1487
-
1488
-
1489
1496
 
1490
-
1491
-
1492
-
1493
-
1494
- <h5>Parameters:</h5>
1495
1497
 
1498
+ </dl>
1496
1499
 
1497
- <table class="params">
1498
- <thead>
1499
- <tr>
1500
-
1501
- <th>Name</th>
1502
-
1503
-
1504
- <th>Type</th>
1505
-
1506
-
1507
-
1508
-
1509
1500
 
1510
- <th class="last">Description</th>
1511
- </tr>
1512
- </thead>
1513
1501
 
1514
- <tbody>
1515
-
1516
1502
 
1517
- <tr>
1518
-
1519
- <td class="name"><code>other</code></td>
1520
-
1521
1503
 
1522
- <td class="type">
1523
-
1524
-
1525
- <span class="param-type"><a href="Resource.html">Resource</a></span>
1526
1504
 
1527
1505
 
1528
-
1529
- </td>
1530
1506
 
1531
-
1532
1507
 
1533
-
1534
1508
 
1535
- <td class="description last">another resource to test against the current one</td>
1536
- </tr>
1537
1509
 
1538
-
1539
- </tbody>
1540
- </table>
1541
1510
 
1542
1511
 
1543
1512
 
@@ -1554,11 +1523,12 @@ the current one. All fields must match.
1554
1523
 
1555
1524
 
1556
1525
 
1557
- <h5>Returns:</h5>
1526
+ <h5 class="h5-returns">Returns:</h5>
1558
1527
 
1559
1528
 
1560
1529
  <div class="param-desc">
1561
- true if these represent the same resource, false otherwise
1530
+ the context of this resource, or undefined if there
1531
+ is no context.
1562
1532
  </div>
1563
1533
 
1564
1534
 
@@ -1569,7 +1539,11 @@ the current one. All fields must match.
1569
1539
  </dt>
1570
1540
  <dd>
1571
1541
 
1572
- <span class="param-type">boolean</span>
1542
+ <span class="param-type">String</span>
1543
+ |
1544
+
1545
+ <span class="param-type">undefined</span>
1546
+
1573
1547
 
1574
1548
 
1575
1549
  </dd>
@@ -1584,7 +1558,7 @@ the current one. All fields must match.
1584
1558
 
1585
1559
 
1586
1560
 
1587
- <h4 class="name" id="escapeText"><span class="type-signature"></span>escapeText<span class="signature">(str)</span><span class="type-signature"> &rarr; {String}</span></h4>
1561
+ <h4 class="name" id="getDataType"><span class="type-signature"></span>getDataType<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
1588
1562
 
1589
1563
 
1590
1564
 
@@ -1592,11 +1566,15 @@ the current one. All fields must match.
1592
1566
 
1593
1567
 
1594
1568
  <dl class="details">
1569
+
1570
+ <dt class="tag-description">Description:</dt>
1571
+ <dd class="tag-description"><ul class="dummy"><li>Return the data type of this resource.</li></ul></dd>
1572
+
1595
1573
 
1596
1574
 
1597
1575
  <dt class="tag-source">Source:</dt>
1598
1576
  <dd class="tag-source"><ul class="dummy"><li>
1599
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line353">line 353</a>
1577
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line154">line 154</a>
1600
1578
  </li></ul></dd>
1601
1579
 
1602
1580
 
@@ -1609,7 +1587,7 @@ the current one. All fields must match.
1609
1587
 
1610
1588
  <dt class="tag-overrides">Overrides:</dt>
1611
1589
  <dd class="tag-overrides"><ul class="dummy"><li>
1612
- <a href="Resource.html#escapeText">Resource#escapeText</a>
1590
+ <a href="Resource.html#getDataType">Resource#getDataType</a>
1613
1591
  </li></ul></dd>
1614
1592
 
1615
1593
 
@@ -1640,69 +1618,12 @@ the current one. All fields must match.
1640
1618
 
1641
1619
 
1642
1620
 
1643
- <div class="description usertext">
1644
- Escape text for writing to a database in a SQL command. This puts single
1645
- quotes around the string, and makes sure that all single quotes within
1646
- the string are escaped.
1647
- </div>
1648
-
1649
-
1650
-
1651
-
1652
-
1653
-
1654
-
1655
-
1656
-
1657
-
1658
-
1659
- <h5>Parameters:</h5>
1660
-
1661
-
1662
- <table class="params">
1663
- <thead>
1664
- <tr>
1665
-
1666
- <th>Name</th>
1667
-
1668
-
1669
- <th>Type</th>
1670
-
1671
-
1672
-
1673
-
1674
-
1675
- <th class="last">Description</th>
1676
- </tr>
1677
- </thead>
1678
-
1679
- <tbody>
1680
-
1681
-
1682
- <tr>
1683
-
1684
- <td class="name"><code>str</code></td>
1685
-
1686
-
1687
- <td class="type">
1688
-
1689
-
1690
- <span class="param-type">Object</span>
1691
1621
 
1692
1622
 
1693
-
1694
- </td>
1695
1623
 
1696
-
1697
1624
 
1698
-
1699
1625
 
1700
- <td class="description last">the item to escape</td>
1701
- </tr>
1702
1626
 
1703
-
1704
- </tbody>
1705
- </table>
1706
1627
 
1707
1628
 
1708
1629
 
@@ -1719,11 +1640,11 @@ the string are escaped.
1719
1640
 
1720
1641
 
1721
1642
 
1722
- <h5>Returns:</h5>
1643
+ <h5 class="h5-returns">Returns:</h5>
1723
1644
 
1724
1645
 
1725
1646
  <div class="param-desc">
1726
- the escaped string
1647
+ the data type of this resource
1727
1648
  </div>
1728
1649
 
1729
1650
 
@@ -1737,6 +1658,7 @@ the string are escaped.
1737
1658
  <span class="param-type">String</span>
1738
1659
 
1739
1660
 
1661
+
1740
1662
  </dd>
1741
1663
  </dl>
1742
1664
 
@@ -1749,7 +1671,7 @@ the string are escaped.
1749
1671
 
1750
1672
 
1751
1673
 
1752
- <h4 class="name" id="getAutoKey"><span class="type-signature"></span>getAutoKey<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
1674
+ <h4 class="name" id="getFlavor"><span class="type-signature"></span>getFlavor<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
1753
1675
 
1754
1676
 
1755
1677
 
@@ -1757,11 +1679,16 @@ the string are escaped.
1757
1679
 
1758
1680
 
1759
1681
  <dl class="details">
1682
+
1683
+ <dt class="tag-description">Description:</dt>
1684
+ <dd class="tag-description"><ul class="dummy"><li>Return the name of the flavor for this resource, or undefined
1685
+ for the "main" or default flavor.</li></ul></dd>
1686
+
1760
1687
 
1761
1688
 
1762
1689
  <dt class="tag-source">Source:</dt>
1763
1690
  <dd class="tag-source"><ul class="dummy"><li>
1764
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line165">line 165</a>
1691
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line319">line 319</a>
1765
1692
  </li></ul></dd>
1766
1693
 
1767
1694
 
@@ -1774,7 +1701,7 @@ the string are escaped.
1774
1701
 
1775
1702
  <dt class="tag-overrides">Overrides:</dt>
1776
1703
  <dd class="tag-overrides"><ul class="dummy"><li>
1777
- <a href="Resource.html#getAutoKey">Resource#getAutoKey</a>
1704
+ <a href="Resource.html#getFlavor">Resource#getFlavor</a>
1778
1705
  </li></ul></dd>
1779
1706
 
1780
1707
 
@@ -1805,13 +1732,6 @@ the string are escaped.
1805
1732
 
1806
1733
 
1807
1734
 
1808
- <div class="description usertext">
1809
- Return true if the key of this resource was automatically generated,
1810
- and false if it was an explicit key.
1811
- </div>
1812
-
1813
-
1814
-
1815
1735
 
1816
1736
 
1817
1737
 
@@ -1834,12 +1754,12 @@ and false if it was an explicit key.
1834
1754
 
1835
1755
 
1836
1756
 
1837
- <h5>Returns:</h5>
1757
+ <h5 class="h5-returns">Returns:</h5>
1838
1758
 
1839
1759
 
1840
1760
  <div class="param-desc">
1841
- true if the key of this string was auto generated,
1842
- false otherwise
1761
+ the name of the flavor for this
1762
+ resource or undefined for the main or default flavor
1843
1763
  </div>
1844
1764
 
1845
1765
 
@@ -1850,7 +1770,11 @@ false otherwise
1850
1770
  </dt>
1851
1771
  <dd>
1852
1772
 
1853
- <span class="param-type">boolean</span>
1773
+ <span class="param-type">String</span>
1774
+ |
1775
+
1776
+ <span class="param-type">undefined</span>
1777
+
1854
1778
 
1855
1779
 
1856
1780
  </dd>
@@ -1865,7 +1789,7 @@ false otherwise
1865
1789
 
1866
1790
 
1867
1791
 
1868
- <h4 class="name" id="getComment"><span class="type-signature"></span>getComment<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
1792
+ <h4 class="name" id="getId"><span class="type-signature"></span>getId<span class="signature">()</span><span class="type-signature"> &rarr; {number|undefined}</span></h4>
1869
1793
 
1870
1794
 
1871
1795
 
@@ -1873,11 +1797,16 @@ false otherwise
1873
1797
 
1874
1798
 
1875
1799
  <dl class="details">
1800
+
1801
+ <dt class="tag-description">Description:</dt>
1802
+ <dd class="tag-description"><ul class="dummy"><li>Return the database id if this resource has previously been saved in the
1803
+ database.</li></ul></dd>
1804
+
1876
1805
 
1877
1806
 
1878
1807
  <dt class="tag-source">Source:</dt>
1879
1808
  <dd class="tag-source"><ul class="dummy"><li>
1880
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line264">line 264</a>
1809
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line285">line 285</a>
1881
1810
  </li></ul></dd>
1882
1811
 
1883
1812
 
@@ -1890,7 +1819,7 @@ false otherwise
1890
1819
 
1891
1820
  <dt class="tag-overrides">Overrides:</dt>
1892
1821
  <dd class="tag-overrides"><ul class="dummy"><li>
1893
- <a href="Resource.html#getComment">Resource#getComment</a>
1822
+ <a href="Resource.html#getId">Resource#getId</a>
1894
1823
  </li></ul></dd>
1895
1824
 
1896
1825
 
@@ -1921,12 +1850,6 @@ false otherwise
1921
1850
 
1922
1851
 
1923
1852
 
1924
- <div class="description usertext">
1925
- Return the translator's comment for this resource if there is
1926
- one, or undefined if not.
1927
- </div>
1928
-
1929
-
1930
1853
 
1931
1854
 
1932
1855
 
@@ -1949,13 +1872,12 @@ one, or undefined if not.
1949
1872
 
1950
1873
 
1951
1874
 
1952
-
1953
- <h5>Returns:</h5>
1875
+ <h5 class="h5-returns">Returns:</h5>
1954
1876
 
1955
1877
 
1956
1878
  <div class="param-desc">
1957
- the translator's comment for this resource
1958
- if the engineer put one in the code
1879
+ the database id if this resource has previously
1880
+ been saved in the database, or undefined if it is has not
1959
1881
  </div>
1960
1882
 
1961
1883
 
@@ -1966,12 +1888,13 @@ if the engineer put one in the code
1966
1888
  </dt>
1967
1889
  <dd>
1968
1890
 
1969
- <span class="param-type">String</span>
1891
+ <span class="param-type">number</span>
1970
1892
  |
1971
1893
 
1972
1894
  <span class="param-type">undefined</span>
1973
1895
 
1974
1896
 
1897
+
1975
1898
  </dd>
1976
1899
  </dl>
1977
1900
 
@@ -1984,7 +1907,7 @@ if the engineer put one in the code
1984
1907
 
1985
1908
 
1986
1909
 
1987
- <h4 class="name" id="getContext"><span class="type-signature"></span>getContext<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
1910
+ <h4 class="name" id="getInstances"><span class="type-signature"></span>getInstances<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Resource.html">Resource</a>>}</span></h4>
1988
1911
 
1989
1912
 
1990
1913
 
@@ -1992,11 +1915,15 @@ if the engineer put one in the code
1992
1915
 
1993
1916
 
1994
1917
  <dl class="details">
1918
+
1919
+ <dt class="tag-description">Description:</dt>
1920
+ <dd class="tag-description"><ul class="dummy"><li>Return the list of instances of the current resource.</li></ul></dd>
1921
+
1995
1922
 
1996
1923
 
1997
1924
  <dt class="tag-source">Source:</dt>
1998
1925
  <dd class="tag-source"><ul class="dummy"><li>
1999
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line175">line 175</a>
1926
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line448">line 448</a>
2000
1927
  </li></ul></dd>
2001
1928
 
2002
1929
 
@@ -2009,7 +1936,7 @@ if the engineer put one in the code
2009
1936
 
2010
1937
  <dt class="tag-overrides">Overrides:</dt>
2011
1938
  <dd class="tag-overrides"><ul class="dummy"><li>
2012
- <a href="Resource.html#getContext">Resource#getContext</a>
1939
+ <a href="Resource.html#getInstances">Resource#getInstances</a>
2013
1940
  </li></ul></dd>
2014
1941
 
2015
1942
 
@@ -2040,13 +1967,6 @@ if the engineer put one in the code
2040
1967
 
2041
1968
 
2042
1969
 
2043
- <div class="description usertext">
2044
- Return the context of this resource, or undefined if there
2045
- is no context.
2046
- </div>
2047
-
2048
-
2049
-
2050
1970
 
2051
1971
 
2052
1972
 
@@ -2069,12 +1989,12 @@ is no context.
2069
1989
 
2070
1990
 
2071
1991
 
2072
- <h5>Returns:</h5>
1992
+ <h5 class="h5-returns">Returns:</h5>
2073
1993
 
2074
1994
 
2075
1995
  <div class="param-desc">
2076
- the context of this resource, or undefined if there
2077
- is no context.
1996
+ the list of instances of
1997
+ the current resource
2078
1998
  </div>
2079
1999
 
2080
2000
 
@@ -2085,10 +2005,8 @@ is no context.
2085
2005
  </dt>
2086
2006
  <dd>
2087
2007
 
2088
- <span class="param-type">String</span>
2089
- |
2008
+ <span class="param-type">Array.&lt;<a href="Resource.html">Resource</a>></span>
2090
2009
 
2091
- <span class="param-type">undefined</span>
2092
2010
 
2093
2011
 
2094
2012
  </dd>
@@ -2103,7 +2021,7 @@ is no context.
2103
2021
 
2104
2022
 
2105
2023
 
2106
- <h4 class="name" id="getDataType"><span class="type-signature"></span>getDataType<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
2024
+ <h4 class="name" id="getKey"><span class="type-signature"></span>getKey<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
2107
2025
 
2108
2026
 
2109
2027
 
@@ -2111,11 +2029,15 @@ is no context.
2111
2029
 
2112
2030
 
2113
2031
  <dl class="details">
2032
+
2033
+ <dt class="tag-description">Description:</dt>
2034
+ <dd class="tag-description"><ul class="dummy"><li>Return the unique key of this resource.</li></ul></dd>
2035
+
2114
2036
 
2115
2037
 
2116
2038
  <dt class="tag-source">Source:</dt>
2117
2039
  <dd class="tag-source"><ul class="dummy"><li>
2118
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line154">line 154</a>
2040
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line115">line 115</a>
2119
2041
  </li></ul></dd>
2120
2042
 
2121
2043
 
@@ -2128,7 +2050,7 @@ is no context.
2128
2050
 
2129
2051
  <dt class="tag-overrides">Overrides:</dt>
2130
2052
  <dd class="tag-overrides"><ul class="dummy"><li>
2131
- <a href="Resource.html#getDataType">Resource#getDataType</a>
2053
+ <a href="Resource.html#getKey">Resource#getKey</a>
2132
2054
  </li></ul></dd>
2133
2055
 
2134
2056
 
@@ -2159,11 +2081,6 @@ is no context.
2159
2081
 
2160
2082
 
2161
2083
 
2162
- <div class="description usertext">
2163
- Return the data type of this resource.
2164
- </div>
2165
-
2166
-
2167
2084
 
2168
2085
 
2169
2086
 
@@ -2186,12 +2103,11 @@ is no context.
2186
2103
 
2187
2104
 
2188
2105
 
2189
-
2190
- <h5>Returns:</h5>
2106
+ <h5 class="h5-returns">Returns:</h5>
2191
2107
 
2192
2108
 
2193
2109
  <div class="param-desc">
2194
- the data type of this resource
2110
+ the unique key of this resource
2195
2111
  </div>
2196
2112
 
2197
2113
 
@@ -2205,6 +2121,7 @@ is no context.
2205
2121
  <span class="param-type">String</span>
2206
2122
 
2207
2123
 
2124
+
2208
2125
  </dd>
2209
2126
  </dl>
2210
2127
 
@@ -2217,7 +2134,7 @@ is no context.
2217
2134
 
2218
2135
 
2219
2136
 
2220
- <h4 class="name" id="getFlavor"><span class="type-signature"></span>getFlavor<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
2137
+ <h4 class="name" id="getLocalize"><span class="type-signature"></span>getLocalize<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
2221
2138
 
2222
2139
 
2223
2140
 
@@ -2225,11 +2142,17 @@ is no context.
2225
2142
 
2226
2143
 
2227
2144
  <dl class="details">
2145
+
2146
+ <dt class="tag-description">Description:</dt>
2147
+ <dd class="tag-description"><ul class="dummy"><li>Return the localize flag of this resource.
2148
+ This flag indicates whether we should look up a translation for this resource.
2149
+ When false, we should simply substitute the source back</li></ul></dd>
2150
+
2228
2151
 
2229
2152
 
2230
2153
  <dt class="tag-source">Source:</dt>
2231
2154
  <dd class="tag-source"><ul class="dummy"><li>
2232
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line319">line 319</a>
2155
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line308">line 308</a>
2233
2156
  </li></ul></dd>
2234
2157
 
2235
2158
 
@@ -2242,7 +2165,7 @@ is no context.
2242
2165
 
2243
2166
  <dt class="tag-overrides">Overrides:</dt>
2244
2167
  <dd class="tag-overrides"><ul class="dummy"><li>
2245
- <a href="Resource.html#getFlavor">Resource#getFlavor</a>
2168
+ <a href="Resource.html#getLocalize">Resource#getLocalize</a>
2246
2169
  </li></ul></dd>
2247
2170
 
2248
2171
 
@@ -2273,13 +2196,6 @@ is no context.
2273
2196
 
2274
2197
 
2275
2198
 
2276
- <div class="description usertext">
2277
- Return the name of the flavor for this resource, or undefined
2278
- for the "main" or default flavor.
2279
- </div>
2280
-
2281
-
2282
-
2283
2199
 
2284
2200
 
2285
2201
 
@@ -2302,12 +2218,11 @@ for the "main" or default flavor.
2302
2218
 
2303
2219
 
2304
2220
 
2305
- <h5>Returns:</h5>
2221
+ <h5 class="h5-returns">Returns:</h5>
2306
2222
 
2307
2223
 
2308
2224
  <div class="param-desc">
2309
- the name of the flavor for this
2310
- resource or undefined for the main or default flavor
2225
+ the localize flag of this resource
2311
2226
  </div>
2312
2227
 
2313
2228
 
@@ -2318,10 +2233,8 @@ for the "main" or default flavor.
2318
2233
  </dt>
2319
2234
  <dd>
2320
2235
 
2321
- <span class="param-type">String</span>
2322
- |
2236
+ <span class="param-type">Boolean</span>
2323
2237
 
2324
- <span class="param-type">undefined</span>
2325
2238
 
2326
2239
 
2327
2240
  </dd>
@@ -2336,7 +2249,7 @@ for the "main" or default flavor.
2336
2249
 
2337
2250
 
2338
2251
 
2339
- <h4 class="name" id="getId"><span class="type-signature"></span>getId<span class="signature">()</span><span class="type-signature"> &rarr; {number|undefined}</span></h4>
2252
+ <h4 class="name" id="getOrigin"><span class="type-signature"></span>getOrigin<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
2340
2253
 
2341
2254
 
2342
2255
 
@@ -2344,11 +2257,18 @@ for the "main" or default flavor.
2344
2257
 
2345
2258
 
2346
2259
  <dl class="details">
2260
+
2261
+ <dt class="tag-description">Description:</dt>
2262
+ <dd class="tag-description"><ul class="dummy"><li>Return the origin of this resource. The origin may be either the string
2263
+ "source" or "target". Source origin resources are ones that are extracted
2264
+ from the source code, whereas target ones are translations from the
2265
+ translators.</li></ul></dd>
2266
+
2347
2267
 
2348
2268
 
2349
2269
  <dt class="tag-source">Source:</dt>
2350
2270
  <dd class="tag-source"><ul class="dummy"><li>
2351
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line285">line 285</a>
2271
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line297">line 297</a>
2352
2272
  </li></ul></dd>
2353
2273
 
2354
2274
 
@@ -2361,7 +2281,7 @@ for the "main" or default flavor.
2361
2281
 
2362
2282
  <dt class="tag-overrides">Overrides:</dt>
2363
2283
  <dd class="tag-overrides"><ul class="dummy"><li>
2364
- <a href="Resource.html#getId">Resource#getId</a>
2284
+ <a href="Resource.html#getOrigin">Resource#getOrigin</a>
2365
2285
  </li></ul></dd>
2366
2286
 
2367
2287
 
@@ -2392,13 +2312,6 @@ for the "main" or default flavor.
2392
2312
 
2393
2313
 
2394
2314
 
2395
- <div class="description usertext">
2396
- Return the database id if this resource has previously been saved in the
2397
- database.
2398
- </div>
2399
-
2400
-
2401
-
2402
2315
 
2403
2316
 
2404
2317
 
@@ -2421,12 +2334,11 @@ database.
2421
2334
 
2422
2335
 
2423
2336
 
2424
- <h5>Returns:</h5>
2337
+ <h5 class="h5-returns">Returns:</h5>
2425
2338
 
2426
2339
 
2427
2340
  <div class="param-desc">
2428
- the database id if this resource has previously
2429
- been saved in the database, or undefined if it is has not
2341
+ the origin of this resource
2430
2342
  </div>
2431
2343
 
2432
2344
 
@@ -2437,10 +2349,8 @@ been saved in the database, or undefined if it is has not
2437
2349
  </dt>
2438
2350
  <dd>
2439
2351
 
2440
- <span class="param-type">number</span>
2441
- |
2352
+ <span class="param-type">String</span>
2442
2353
 
2443
- <span class="param-type">undefined</span>
2444
2354
 
2445
2355
 
2446
2356
  </dd>
@@ -2455,7 +2365,7 @@ been saved in the database, or undefined if it is has not
2455
2365
 
2456
2366
 
2457
2367
 
2458
- <h4 class="name" id="getInstances"><span class="type-signature"></span>getInstances<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Resource.html">Resource</a>>}</span></h4>
2368
+ <h4 class="name" id="getPath"><span class="type-signature"></span>getPath<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
2459
2369
 
2460
2370
 
2461
2371
 
@@ -2463,11 +2373,16 @@ been saved in the database, or undefined if it is has not
2463
2373
 
2464
2374
 
2465
2375
  <dl class="details">
2376
+
2377
+ <dt class="tag-description">Description:</dt>
2378
+ <dd class="tag-description"><ul class="dummy"><li>Return the original path to the file from which this resource was
2379
+ originally extracted.</li></ul></dd>
2380
+
2466
2381
 
2467
2382
 
2468
2383
  <dt class="tag-source">Source:</dt>
2469
2384
  <dd class="tag-source"><ul class="dummy"><li>
2470
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line448">line 448</a>
2385
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line253">line 253</a>
2471
2386
  </li></ul></dd>
2472
2387
 
2473
2388
 
@@ -2480,7 +2395,7 @@ been saved in the database, or undefined if it is has not
2480
2395
 
2481
2396
  <dt class="tag-overrides">Overrides:</dt>
2482
2397
  <dd class="tag-overrides"><ul class="dummy"><li>
2483
- <a href="Resource.html#getInstances">Resource#getInstances</a>
2398
+ <a href="Resource.html#getPath">Resource#getPath</a>
2484
2399
  </li></ul></dd>
2485
2400
 
2486
2401
 
@@ -2511,12 +2426,6 @@ been saved in the database, or undefined if it is has not
2511
2426
 
2512
2427
 
2513
2428
 
2514
- <div class="description usertext">
2515
- Return the list of instances of the current resource.
2516
- </div>
2517
-
2518
-
2519
-
2520
2429
 
2521
2430
 
2522
2431
 
@@ -2539,12 +2448,11 @@ been saved in the database, or undefined if it is has not
2539
2448
 
2540
2449
 
2541
2450
 
2542
- <h5>Returns:</h5>
2451
+ <h5 class="h5-returns">Returns:</h5>
2543
2452
 
2544
2453
 
2545
2454
  <div class="param-desc">
2546
- the list of instances of
2547
- the current resource
2455
+ the path to the file containing this resource
2548
2456
  </div>
2549
2457
 
2550
2458
 
@@ -2555,7 +2463,8 @@ the current resource
2555
2463
  </dt>
2556
2464
  <dd>
2557
2465
 
2558
- <span class="param-type">Array.&lt;<a href="Resource.html">Resource</a>></span>
2466
+ <span class="param-type">String</span>
2467
+
2559
2468
 
2560
2469
 
2561
2470
  </dd>
@@ -2570,7 +2479,7 @@ the current resource
2570
2479
 
2571
2480
 
2572
2481
 
2573
- <h4 class="name" id="getKey"><span class="type-signature"></span>getKey<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
2482
+ <h4 class="name" id="getProject"><span class="type-signature"></span>getProject<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
2574
2483
 
2575
2484
 
2576
2485
 
@@ -2578,11 +2487,15 @@ the current resource
2578
2487
 
2579
2488
 
2580
2489
  <dl class="details">
2490
+
2491
+ <dt class="tag-description">Description:</dt>
2492
+ <dd class="tag-description"><ul class="dummy"><li>Return the project that this resource was found in.</li></ul></dd>
2493
+
2581
2494
 
2582
2495
 
2583
2496
  <dt class="tag-source">Source:</dt>
2584
2497
  <dd class="tag-source"><ul class="dummy"><li>
2585
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line115">line 115</a>
2498
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line106">line 106</a>
2586
2499
  </li></ul></dd>
2587
2500
 
2588
2501
 
@@ -2595,7 +2508,7 @@ the current resource
2595
2508
 
2596
2509
  <dt class="tag-overrides">Overrides:</dt>
2597
2510
  <dd class="tag-overrides"><ul class="dummy"><li>
2598
- <a href="Resource.html#getKey">Resource#getKey</a>
2511
+ <a href="Resource.html#getProject">Resource#getProject</a>
2599
2512
  </li></ul></dd>
2600
2513
 
2601
2514
 
@@ -2626,11 +2539,6 @@ the current resource
2626
2539
 
2627
2540
 
2628
2541
 
2629
- <div class="description usertext">
2630
- Return the unique key of this resource.
2631
- </div>
2632
-
2633
-
2634
2542
 
2635
2543
 
2636
2544
 
@@ -2653,12 +2561,11 @@ the current resource
2653
2561
 
2654
2562
 
2655
2563
 
2656
-
2657
- <h5>Returns:</h5>
2564
+ <h5 class="h5-returns">Returns:</h5>
2658
2565
 
2659
2566
 
2660
2567
  <div class="param-desc">
2661
- the unique key of this resource
2568
+ the project of this resource
2662
2569
  </div>
2663
2570
 
2664
2571
 
@@ -2672,6 +2579,7 @@ the current resource
2672
2579
  <span class="param-type">String</span>
2673
2580
 
2674
2581
 
2582
+
2675
2583
  </dd>
2676
2584
  </dl>
2677
2585
 
@@ -2684,7 +2592,7 @@ the current resource
2684
2592
 
2685
2593
 
2686
2594
 
2687
- <h4 class="name" id="getLocalize"><span class="type-signature"></span>getLocalize<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
2595
+ <h4 class="name" id="getSource"><span class="type-signature"></span>getSource<span class="signature">()</span><span class="type-signature"> &rarr; {String|Array.&lt;String>|Object}</span></h4>
2688
2596
 
2689
2597
 
2690
2598
 
@@ -2692,11 +2600,15 @@ the current resource
2692
2600
 
2693
2601
 
2694
2602
  <dl class="details">
2603
+
2604
+ <dt class="tag-description">Description:</dt>
2605
+ <dd class="tag-description"><ul class="dummy"><li>Return the source string or strings for this resource.</li></ul></dd>
2606
+
2695
2607
 
2696
2608
 
2697
2609
  <dt class="tag-source">Source:</dt>
2698
2610
  <dd class="tag-source"><ul class="dummy"><li>
2699
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line308">line 308</a>
2611
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line125">line 125</a>
2700
2612
  </li></ul></dd>
2701
2613
 
2702
2614
 
@@ -2709,7 +2621,7 @@ the current resource
2709
2621
 
2710
2622
  <dt class="tag-overrides">Overrides:</dt>
2711
2623
  <dd class="tag-overrides"><ul class="dummy"><li>
2712
- <a href="Resource.html#getLocalize">Resource#getLocalize</a>
2624
+ <a href="Resource.html#getSource">Resource#getSource</a>
2713
2625
  </li></ul></dd>
2714
2626
 
2715
2627
 
@@ -2740,12 +2652,6 @@ the current resource
2740
2652
 
2741
2653
 
2742
2654
 
2743
- <div class="description usertext">
2744
- Return the localize flag of this resource.
2745
- This flag indicates whether we should look up a translation for this resource.
2746
- When false, we should simply substitute the source back
2747
- </div>
2748
-
2749
2655
 
2750
2656
 
2751
2657
 
@@ -2768,13 +2674,12 @@ When false, we should simply substitute the source back
2768
2674
 
2769
2675
 
2770
2676
 
2771
-
2772
-
2773
- <h5>Returns:</h5>
2677
+ <h5 class="h5-returns">Returns:</h5>
2774
2678
 
2775
2679
 
2776
2680
  <div class="param-desc">
2777
- the localize flag of this resource
2681
+ the source string or
2682
+ strings of this resource
2778
2683
  </div>
2779
2684
 
2780
2685
 
@@ -2785,7 +2690,14 @@ When false, we should simply substitute the source back
2785
2690
  </dt>
2786
2691
  <dd>
2787
2692
 
2788
- <span class="param-type">Boolean</span>
2693
+ <span class="param-type">String</span>
2694
+ |
2695
+
2696
+ <span class="param-type">Array.&lt;String></span>
2697
+ |
2698
+
2699
+ <span class="param-type">Object</span>
2700
+
2789
2701
 
2790
2702
 
2791
2703
  </dd>
@@ -2800,7 +2712,7 @@ When false, we should simply substitute the source back
2800
2712
 
2801
2713
 
2802
2714
 
2803
- <h4 class="name" id="getOrigin"><span class="type-signature"></span>getOrigin<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
2715
+ <h4 class="name" id="getSourceLocale"><span class="type-signature"></span>getSourceLocale<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
2804
2716
 
2805
2717
 
2806
2718
 
@@ -2808,11 +2720,16 @@ When false, we should simply substitute the source back
2808
2720
 
2809
2721
 
2810
2722
  <dl class="details">
2723
+
2724
+ <dt class="tag-description">Description:</dt>
2725
+ <dd class="tag-description"><ul class="dummy"><li>Return the source locale of this resource, or undefined if there
2726
+ is no context or the locale is the same as the project's source locale.</li></ul></dd>
2727
+
2811
2728
 
2812
2729
 
2813
2730
  <dt class="tag-source">Source:</dt>
2814
2731
  <dd class="tag-source"><ul class="dummy"><li>
2815
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line297">line 297</a>
2732
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line185">line 185</a>
2816
2733
  </li></ul></dd>
2817
2734
 
2818
2735
 
@@ -2825,7 +2742,7 @@ When false, we should simply substitute the source back
2825
2742
 
2826
2743
  <dt class="tag-overrides">Overrides:</dt>
2827
2744
  <dd class="tag-overrides"><ul class="dummy"><li>
2828
- <a href="Resource.html#getOrigin">Resource#getOrigin</a>
2745
+ <a href="Resource.html#getSourceLocale">Resource#getSourceLocale</a>
2829
2746
  </li></ul></dd>
2830
2747
 
2831
2748
 
@@ -2856,15 +2773,6 @@ When false, we should simply substitute the source back
2856
2773
 
2857
2774
 
2858
2775
 
2859
- <div class="description usertext">
2860
- Return the origin of this resource. The origin may be either the string
2861
- "source" or "target". Source origin resources are ones that are extracted
2862
- from the source code, whereas target ones are translations from the
2863
- translators.
2864
- </div>
2865
-
2866
-
2867
-
2868
2776
 
2869
2777
 
2870
2778
 
@@ -2887,11 +2795,12 @@ translators.
2887
2795
 
2888
2796
 
2889
2797
 
2890
- <h5>Returns:</h5>
2798
+ <h5 class="h5-returns">Returns:</h5>
2891
2799
 
2892
2800
 
2893
2801
  <div class="param-desc">
2894
- the origin of this resource
2802
+ the locale of this resource, or undefined if there
2803
+ is no locale.
2895
2804
  </div>
2896
2805
 
2897
2806
 
@@ -2903,6 +2812,10 @@ translators.
2903
2812
  <dd>
2904
2813
 
2905
2814
  <span class="param-type">String</span>
2815
+ |
2816
+
2817
+ <span class="param-type">undefined</span>
2818
+
2906
2819
 
2907
2820
 
2908
2821
  </dd>
@@ -2917,7 +2830,7 @@ translators.
2917
2830
 
2918
2831
 
2919
2832
 
2920
- <h4 class="name" id="getPath"><span class="type-signature"></span>getPath<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
2833
+ <h4 class="name" id="getState"><span class="type-signature"></span>getState<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
2921
2834
 
2922
2835
 
2923
2836
 
@@ -2925,11 +2838,17 @@ translators.
2925
2838
 
2926
2839
 
2927
2840
  <dl class="details">
2841
+
2842
+ <dt class="tag-description">Description:</dt>
2843
+ <dd class="tag-description"><ul class="dummy"><li>Return the state of this resource. This is a string that gives the
2844
+ stage of life of this resource. Currently, it can be one of "new",
2845
+ "translated", or "accepted".</li></ul></dd>
2846
+
2928
2847
 
2929
2848
 
2930
2849
  <dt class="tag-source">Source:</dt>
2931
2850
  <dd class="tag-source"><ul class="dummy"><li>
2932
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line253">line 253</a>
2851
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line222">line 222</a>
2933
2852
  </li></ul></dd>
2934
2853
 
2935
2854
 
@@ -2942,7 +2861,7 @@ translators.
2942
2861
 
2943
2862
  <dt class="tag-overrides">Overrides:</dt>
2944
2863
  <dd class="tag-overrides"><ul class="dummy"><li>
2945
- <a href="Resource.html#getPath">Resource#getPath</a>
2864
+ <a href="Resource.html#getState">Resource#getState</a>
2946
2865
  </li></ul></dd>
2947
2866
 
2948
2867
 
@@ -2973,13 +2892,6 @@ translators.
2973
2892
 
2974
2893
 
2975
2894
 
2976
- <div class="description usertext">
2977
- Return the original path to the file from which this resource was
2978
- originally extracted.
2979
- </div>
2980
-
2981
-
2982
-
2983
2895
 
2984
2896
 
2985
2897
 
@@ -3002,11 +2914,11 @@ originally extracted.
3002
2914
 
3003
2915
 
3004
2916
 
3005
- <h5>Returns:</h5>
2917
+ <h5 class="h5-returns">Returns:</h5>
3006
2918
 
3007
2919
 
3008
2920
  <div class="param-desc">
3009
- the path to the file containing this resource
2921
+ the state of this resource
3010
2922
  </div>
3011
2923
 
3012
2924
 
@@ -3020,6 +2932,7 @@ originally extracted.
3020
2932
  <span class="param-type">String</span>
3021
2933
 
3022
2934
 
2935
+
3023
2936
  </dd>
3024
2937
  </dl>
3025
2938
 
@@ -3032,7 +2945,7 @@ originally extracted.
3032
2945
 
3033
2946
 
3034
2947
 
3035
- <h4 class="name" id="getProject"><span class="type-signature"></span>getProject<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
2948
+ <h4 class="name" id="getTarget"><span class="type-signature"></span>getTarget<span class="signature">()</span><span class="type-signature"> &rarr; {String|Array.&lt;String>|Object}</span></h4>
3036
2949
 
3037
2950
 
3038
2951
 
@@ -3040,11 +2953,15 @@ originally extracted.
3040
2953
 
3041
2954
 
3042
2955
  <dl class="details">
2956
+
2957
+ <dt class="tag-description">Description:</dt>
2958
+ <dd class="tag-description"><ul class="dummy"><li>Return the target string or strings for this resource.</li></ul></dd>
2959
+
3043
2960
 
3044
2961
 
3045
2962
  <dt class="tag-source">Source:</dt>
3046
2963
  <dd class="tag-source"><ul class="dummy"><li>
3047
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line106">line 106</a>
2964
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line135">line 135</a>
3048
2965
  </li></ul></dd>
3049
2966
 
3050
2967
 
@@ -3057,7 +2974,7 @@ originally extracted.
3057
2974
 
3058
2975
  <dt class="tag-overrides">Overrides:</dt>
3059
2976
  <dd class="tag-overrides"><ul class="dummy"><li>
3060
- <a href="Resource.html#getProject">Resource#getProject</a>
2977
+ <a href="Resource.html#getTarget">Resource#getTarget</a>
3061
2978
  </li></ul></dd>
3062
2979
 
3063
2980
 
@@ -3088,12 +3005,6 @@ originally extracted.
3088
3005
 
3089
3006
 
3090
3007
 
3091
- <div class="description usertext">
3092
- Return the project that this resource was found in.
3093
- </div>
3094
-
3095
-
3096
-
3097
3008
 
3098
3009
 
3099
3010
 
@@ -3116,11 +3027,12 @@ originally extracted.
3116
3027
 
3117
3028
 
3118
3029
 
3119
- <h5>Returns:</h5>
3030
+ <h5 class="h5-returns">Returns:</h5>
3120
3031
 
3121
3032
 
3122
3033
  <div class="param-desc">
3123
- the project of this resource
3034
+ the source string or
3035
+ strings of this resource
3124
3036
  </div>
3125
3037
 
3126
3038
 
@@ -3132,6 +3044,13 @@ originally extracted.
3132
3044
  <dd>
3133
3045
 
3134
3046
  <span class="param-type">String</span>
3047
+ |
3048
+
3049
+ <span class="param-type">Array.&lt;String></span>
3050
+ |
3051
+
3052
+ <span class="param-type">Object</span>
3053
+
3135
3054
 
3136
3055
 
3137
3056
  </dd>
@@ -3146,7 +3065,7 @@ originally extracted.
3146
3065
 
3147
3066
 
3148
3067
 
3149
- <h4 class="name" id="getSource"><span class="type-signature"></span>getSource<span class="signature">()</span><span class="type-signature"> &rarr; {String|Array.&lt;String>|Object}</span></h4>
3068
+ <h4 class="name" id="getTargetLocale"><span class="type-signature"></span>getTargetLocale<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
3150
3069
 
3151
3070
 
3152
3071
 
@@ -3154,11 +3073,16 @@ originally extracted.
3154
3073
 
3155
3074
 
3156
3075
  <dl class="details">
3076
+
3077
+ <dt class="tag-description">Description:</dt>
3078
+ <dd class="tag-description"><ul class="dummy"><li>Return the target locale of this resource, or undefined if the resource
3079
+ is a source-only resource.</li></ul></dd>
3080
+
3157
3081
 
3158
3082
 
3159
3083
  <dt class="tag-source">Source:</dt>
3160
3084
  <dd class="tag-source"><ul class="dummy"><li>
3161
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line125">line 125</a>
3085
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line203">line 203</a>
3162
3086
  </li></ul></dd>
3163
3087
 
3164
3088
 
@@ -3171,7 +3095,7 @@ originally extracted.
3171
3095
 
3172
3096
  <dt class="tag-overrides">Overrides:</dt>
3173
3097
  <dd class="tag-overrides"><ul class="dummy"><li>
3174
- <a href="Resource.html#getSource">Resource#getSource</a>
3098
+ <a href="Resource.html#getTargetLocale">Resource#getTargetLocale</a>
3175
3099
  </li></ul></dd>
3176
3100
 
3177
3101
 
@@ -3202,11 +3126,6 @@ originally extracted.
3202
3126
 
3203
3127
 
3204
3128
 
3205
- <div class="description usertext">
3206
- Return the source string or strings for this resource.
3207
- </div>
3208
-
3209
-
3210
3129
 
3211
3130
 
3212
3131
 
@@ -3229,13 +3148,12 @@ originally extracted.
3229
3148
 
3230
3149
 
3231
3150
 
3232
-
3233
- <h5>Returns:</h5>
3151
+ <h5 class="h5-returns">Returns:</h5>
3234
3152
 
3235
3153
 
3236
3154
  <div class="param-desc">
3237
- the source string or
3238
- strings of this resource
3155
+ the locale of this resource, or undefined if there
3156
+ is no locale.
3239
3157
  </div>
3240
3158
 
3241
3159
 
@@ -3249,10 +3167,8 @@ strings of this resource
3249
3167
  <span class="param-type">String</span>
3250
3168
  |
3251
3169
 
3252
- <span class="param-type">Array.&lt;String></span>
3253
- |
3170
+ <span class="param-type">undefined</span>
3254
3171
 
3255
- <span class="param-type">Object</span>
3256
3172
 
3257
3173
 
3258
3174
  </dd>
@@ -3267,7 +3183,7 @@ strings of this resource
3267
3183
 
3268
3184
 
3269
3185
 
3270
- <h4 class="name" id="getSourceLocale"><span class="type-signature"></span>getSourceLocale<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
3186
+ <h4 class="name" id="getType"><span class="type-signature"></span>getType<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
3271
3187
 
3272
3188
 
3273
3189
 
@@ -3275,11 +3191,16 @@ strings of this resource
3275
3191
 
3276
3192
 
3277
3193
  <dl class="details">
3194
+
3195
+ <dt class="tag-description">Description:</dt>
3196
+ <dd class="tag-description"><ul class="dummy"><li>Return the resource type of this resource. This is one of
3197
+ string, array, or plural.</li></ul></dd>
3198
+
3278
3199
 
3279
3200
 
3280
3201
  <dt class="tag-source">Source:</dt>
3281
3202
  <dd class="tag-source"><ul class="dummy"><li>
3282
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line185">line 185</a>
3203
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line145">line 145</a>
3283
3204
  </li></ul></dd>
3284
3205
 
3285
3206
 
@@ -3292,7 +3213,7 @@ strings of this resource
3292
3213
 
3293
3214
  <dt class="tag-overrides">Overrides:</dt>
3294
3215
  <dd class="tag-overrides"><ul class="dummy"><li>
3295
- <a href="Resource.html#getSourceLocale">Resource#getSourceLocale</a>
3216
+ <a href="Resource.html#getType">Resource#getType</a>
3296
3217
  </li></ul></dd>
3297
3218
 
3298
3219
 
@@ -3323,13 +3244,6 @@ strings of this resource
3323
3244
 
3324
3245
 
3325
3246
 
3326
- <div class="description usertext">
3327
- Return the source locale of this resource, or undefined if there
3328
- is no context or the locale is the same as the project's source locale.
3329
- </div>
3330
-
3331
-
3332
-
3333
3247
 
3334
3248
 
3335
3249
 
@@ -3352,12 +3266,11 @@ is no context or the locale is the same as the project's source locale.
3352
3266
 
3353
3267
 
3354
3268
 
3355
- <h5>Returns:</h5>
3269
+ <h5 class="h5-returns">Returns:</h5>
3356
3270
 
3357
3271
 
3358
3272
  <div class="param-desc">
3359
- the locale of this resource, or undefined if there
3360
- is no locale.
3273
+ the resource type of this resource
3361
3274
  </div>
3362
3275
 
3363
3276
 
@@ -3369,9 +3282,7 @@ is no locale.
3369
3282
  <dd>
3370
3283
 
3371
3284
  <span class="param-type">String</span>
3372
- |
3373
3285
 
3374
- <span class="param-type">undefined</span>
3375
3286
 
3376
3287
 
3377
3288
  </dd>
@@ -3386,7 +3297,7 @@ is no locale.
3386
3297
 
3387
3298
 
3388
3299
 
3389
- <h4 class="name" id="getState"><span class="type-signature"></span>getState<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
3300
+ <h4 class="name" id="hashKey"><span class="type-signature"></span>hashKey<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
3390
3301
 
3391
3302
 
3392
3303
 
@@ -3394,11 +3305,15 @@ is no locale.
3394
3305
 
3395
3306
 
3396
3307
  <dl class="details">
3308
+
3309
+ <dt class="tag-description">Description:</dt>
3310
+ <dd class="tag-description"><ul class="dummy"><li>Return the a hash key that uniquely identifies this resource.</li></ul></dd>
3311
+
3397
3312
 
3398
3313
 
3399
3314
  <dt class="tag-source">Source:</dt>
3400
3315
  <dd class="tag-source"><ul class="dummy"><li>
3401
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line222">line 222</a>
3316
+ <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line163">line 163</a>
3402
3317
  </li></ul></dd>
3403
3318
 
3404
3319
 
@@ -3409,11 +3324,6 @@ is no locale.
3409
3324
 
3410
3325
 
3411
3326
 
3412
- <dt class="tag-overrides">Overrides:</dt>
3413
- <dd class="tag-overrides"><ul class="dummy"><li>
3414
- <a href="Resource.html#getState">Resource#getState</a>
3415
- </li></ul></dd>
3416
-
3417
3327
 
3418
3328
 
3419
3329
 
@@ -3442,14 +3352,6 @@ is no locale.
3442
3352
 
3443
3353
 
3444
3354
 
3445
- <div class="description usertext">
3446
- Return the state of this resource. This is a string that gives the
3447
- stage of life of this resource. Currently, it can be one of "new",
3448
- "translated", or "accepted".
3449
- </div>
3450
-
3451
-
3452
-
3453
3355
 
3454
3356
 
3455
3357
 
@@ -3472,11 +3374,11 @@ stage of life of this resource. Currently, it can be one of "new",
3472
3374
 
3473
3375
 
3474
3376
 
3475
- <h5>Returns:</h5>
3377
+ <h5 class="h5-returns">Returns:</h5>
3476
3378
 
3477
3379
 
3478
3380
  <div class="param-desc">
3479
- the state of this resource
3381
+ a unique hash key for this resource
3480
3382
  </div>
3481
3383
 
3482
3384
 
@@ -3490,6 +3392,7 @@ stage of life of this resource. Currently, it can be one of "new",
3490
3392
  <span class="param-type">String</span>
3491
3393
 
3492
3394
 
3395
+
3493
3396
  </dd>
3494
3397
  </dl>
3495
3398
 
@@ -3502,7 +3405,7 @@ stage of life of this resource. Currently, it can be one of "new",
3502
3405
 
3503
3406
 
3504
3407
 
3505
- <h4 class="name" id="getTarget"><span class="type-signature"></span>getTarget<span class="signature">()</span><span class="type-signature"> &rarr; {String|Array.&lt;String>|Object}</span></h4>
3408
+ <h4 class="name" id="hashKeyForTranslation"><span class="type-signature"></span>hashKeyForTranslation<span class="signature">(locale)</span><span class="type-signature"> &rarr; {String}</span></h4>
3506
3409
 
3507
3410
 
3508
3411
 
@@ -3510,11 +3413,16 @@ stage of life of this resource. Currently, it can be one of "new",
3510
3413
 
3511
3414
 
3512
3415
  <dl class="details">
3416
+
3417
+ <dt class="tag-description">Description:</dt>
3418
+ <dd class="tag-description"><ul class="dummy"><li>Return the a hash key that uniquely identifies the translation of
3419
+ this resource to the given locale.</li></ul></dd>
3420
+
3513
3421
 
3514
3422
 
3515
3423
  <dt class="tag-source">Source:</dt>
3516
3424
  <dd class="tag-source"><ul class="dummy"><li>
3517
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line135">line 135</a>
3425
+ <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line175">line 175</a>
3518
3426
  </li></ul></dd>
3519
3427
 
3520
3428
 
@@ -3525,11 +3433,6 @@ stage of life of this resource. Currently, it can be one of "new",
3525
3433
 
3526
3434
 
3527
3435
 
3528
- <dt class="tag-overrides">Overrides:</dt>
3529
- <dd class="tag-overrides"><ul class="dummy"><li>
3530
- <a href="Resource.html#getTarget">Resource#getTarget</a>
3531
- </li></ul></dd>
3532
-
3533
3436
 
3534
3437
 
3535
3438
 
@@ -3558,9 +3461,6 @@ stage of life of this resource. Currently, it can be one of "new",
3558
3461
 
3559
3462
 
3560
3463
 
3561
- <div class="description usertext">
3562
- Return the target string or strings for this resource.
3563
- </div>
3564
3464
 
3565
3465
 
3566
3466
 
@@ -3569,7 +3469,54 @@ stage of life of this resource. Currently, it can be one of "new",
3569
3469
 
3570
3470
 
3571
3471
 
3472
+ <h5 class="h5-parameters">Parameters:</h5>
3473
+
3474
+
3475
+ <table class="params">
3476
+ <thead>
3477
+ <tr>
3478
+
3479
+ <th>Name</th>
3480
+
3481
+
3482
+ <th>Type</th>
3483
+
3484
+
3485
+
3486
+
3487
+
3488
+ <th class="last">Description</th>
3489
+ </tr>
3490
+ </thead>
3491
+
3492
+ <tbody>
3493
+
3494
+
3495
+ <tr>
3496
+
3497
+ <td class="name"><code>locale</code></td>
3498
+
3499
+
3500
+ <td class="type">
3501
+
3502
+
3503
+ <span class="param-type">String</span>
3504
+
3505
+
3506
+
3507
+
3508
+ </td>
3509
+
3510
+
3511
+
3512
+
3513
+
3514
+ <td class="description last">a locale spec of the desired translation</td>
3515
+ </tr>
3572
3516
 
3517
+
3518
+ </tbody>
3519
+ </table>
3573
3520
 
3574
3521
 
3575
3522
 
@@ -3586,12 +3533,11 @@ stage of life of this resource. Currently, it can be one of "new",
3586
3533
 
3587
3534
 
3588
3535
 
3589
- <h5>Returns:</h5>
3536
+ <h5 class="h5-returns">Returns:</h5>
3590
3537
 
3591
3538
 
3592
3539
  <div class="param-desc">
3593
- the source string or
3594
- strings of this resource
3540
+ a unique hash key for this resource
3595
3541
  </div>
3596
3542
 
3597
3543
 
@@ -3603,12 +3549,7 @@ strings of this resource
3603
3549
  <dd>
3604
3550
 
3605
3551
  <span class="param-type">String</span>
3606
- |
3607
-
3608
- <span class="param-type">Array.&lt;String></span>
3609
- |
3610
3552
 
3611
- <span class="param-type">Object</span>
3612
3553
 
3613
3554
 
3614
3555
  </dd>
@@ -3623,7 +3564,7 @@ strings of this resource
3623
3564
 
3624
3565
 
3625
3566
 
3626
- <h4 class="name" id="getTargetLocale"><span class="type-signature"></span>getTargetLocale<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
3567
+ <h4 class="name" id="isInstance"><span class="type-signature"></span>isInstance<span class="signature">(a)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
3627
3568
 
3628
3569
 
3629
3570
 
@@ -3631,11 +3572,16 @@ strings of this resource
3631
3572
 
3632
3573
 
3633
3574
  <dl class="details">
3575
+
3576
+ <dt class="tag-description">Description:</dt>
3577
+ <dd class="tag-description"><ul class="dummy"><li>Check if the given resource is an instance of the current
3578
+ resource.</li></ul></dd>
3579
+
3634
3580
 
3635
3581
 
3636
3582
  <dt class="tag-source">Source:</dt>
3637
3583
  <dd class="tag-source"><ul class="dummy"><li>
3638
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line203">line 203</a>
3584
+ <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line209">line 209</a>
3639
3585
  </li></ul></dd>
3640
3586
 
3641
3587
 
@@ -3648,7 +3594,7 @@ strings of this resource
3648
3594
 
3649
3595
  <dt class="tag-overrides">Overrides:</dt>
3650
3596
  <dd class="tag-overrides"><ul class="dummy"><li>
3651
- <a href="Resource.html#getTargetLocale">Resource#getTargetLocale</a>
3597
+ <a href="Resource.html#isInstance">Resource#isInstance</a>
3652
3598
  </li></ul></dd>
3653
3599
 
3654
3600
 
@@ -3679,10 +3625,6 @@ strings of this resource
3679
3625
 
3680
3626
 
3681
3627
 
3682
- <div class="description usertext">
3683
- Return the target locale of this resource, or undefined if the resource
3684
- is a source-only resource.
3685
- </div>
3686
3628
 
3687
3629
 
3688
3630
 
@@ -3691,7 +3633,54 @@ is a source-only resource.
3691
3633
 
3692
3634
 
3693
3635
 
3636
+ <h5 class="h5-parameters">Parameters:</h5>
3637
+
3638
+
3639
+ <table class="params">
3640
+ <thead>
3641
+ <tr>
3642
+
3643
+ <th>Name</th>
3644
+
3645
+
3646
+ <th>Type</th>
3647
+
3648
+
3649
+
3650
+
3651
+
3652
+ <th class="last">Description</th>
3653
+ </tr>
3654
+ </thead>
3655
+
3656
+ <tbody>
3657
+
3658
+
3659
+ <tr>
3660
+
3661
+ <td class="name"><code>a</code></td>
3662
+
3663
+
3664
+ <td class="type">
3665
+
3666
+
3667
+ <span class="param-type"><a href="Resource.html">Resource</a></span>
3668
+
3669
+
3670
+
3671
+
3672
+ </td>
3673
+
3674
+
3675
+
3676
+
3677
+
3678
+ <td class="description last">resource to check</td>
3679
+ </tr>
3694
3680
 
3681
+
3682
+ </tbody>
3683
+ </table>
3695
3684
 
3696
3685
 
3697
3686
 
@@ -3708,12 +3697,12 @@ is a source-only resource.
3708
3697
 
3709
3698
 
3710
3699
 
3711
- <h5>Returns:</h5>
3700
+ <h5 class="h5-returns">Returns:</h5>
3712
3701
 
3713
3702
 
3714
3703
  <div class="param-desc">
3715
- the locale of this resource, or undefined if there
3716
- is no locale.
3704
+ true if this is an instance of
3705
+ the current resource, false otherwise.
3717
3706
  </div>
3718
3707
 
3719
3708
 
@@ -3724,10 +3713,8 @@ is no locale.
3724
3713
  </dt>
3725
3714
  <dd>
3726
3715
 
3727
- <span class="param-type">String</span>
3728
- |
3716
+ <span class="param-type">boolean</span>
3729
3717
 
3730
- <span class="param-type">undefined</span>
3731
3718
 
3732
3719
 
3733
3720
  </dd>
@@ -3742,7 +3729,7 @@ is no locale.
3742
3729
 
3743
3730
 
3744
3731
 
3745
- <h4 class="name" id="getType"><span class="type-signature"></span>getType<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
3732
+ <h4 class="name" id="same"><span class="type-signature"></span>same<span class="signature">(other)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
3746
3733
 
3747
3734
 
3748
3735
 
@@ -3750,11 +3737,18 @@ is no locale.
3750
3737
 
3751
3738
 
3752
3739
  <dl class="details">
3740
+
3741
+ <dt class="tag-description">Description:</dt>
3742
+ <dd class="tag-description"><ul class="dummy"><li>Return true if the other resource represents the same resource as
3743
+ the current one. The project, context, locale, key, flavor, and type must
3744
+ match. Other fields such as the pathName, state, and comment fields are
3745
+ ignored as minor variations.</li></ul></dd>
3746
+
3753
3747
 
3754
3748
 
3755
3749
  <dt class="tag-source">Source:</dt>
3756
3750
  <dd class="tag-source"><ul class="dummy"><li>
3757
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line145">line 145</a>
3751
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line332">line 332</a>
3758
3752
  </li></ul></dd>
3759
3753
 
3760
3754
 
@@ -3767,7 +3761,7 @@ is no locale.
3767
3761
 
3768
3762
  <dt class="tag-overrides">Overrides:</dt>
3769
3763
  <dd class="tag-overrides"><ul class="dummy"><li>
3770
- <a href="Resource.html#getType">Resource#getType</a>
3764
+ <a href="Resource.html#same">Resource#same</a>
3771
3765
  </li></ul></dd>
3772
3766
 
3773
3767
 
@@ -3798,10 +3792,6 @@ is no locale.
3798
3792
 
3799
3793
 
3800
3794
 
3801
- <div class="description usertext">
3802
- Return the resource type of this resource. This is one of
3803
- string, array, or plural.
3804
- </div>
3805
3795
 
3806
3796
 
3807
3797
 
@@ -3810,7 +3800,54 @@ string, array, or plural.
3810
3800
 
3811
3801
 
3812
3802
 
3803
+ <h5 class="h5-parameters">Parameters:</h5>
3804
+
3805
+
3806
+ <table class="params">
3807
+ <thead>
3808
+ <tr>
3809
+
3810
+ <th>Name</th>
3811
+
3812
+
3813
+ <th>Type</th>
3814
+
3815
+
3816
+
3817
+
3818
+
3819
+ <th class="last">Description</th>
3820
+ </tr>
3821
+ </thead>
3822
+
3823
+ <tbody>
3824
+
3825
+
3826
+ <tr>
3827
+
3828
+ <td class="name"><code>other</code></td>
3829
+
3830
+
3831
+ <td class="type">
3832
+
3833
+
3834
+ <span class="param-type"><a href="Resource.html">Resource</a></span>
3835
+
3836
+
3837
+
3838
+
3839
+ </td>
3840
+
3841
+
3842
+
3843
+
3844
+
3845
+ <td class="description last">another resource to test against the current one</td>
3846
+ </tr>
3813
3847
 
3848
+
3849
+ </tbody>
3850
+ </table>
3814
3851
 
3815
3852
 
3816
3853
 
@@ -3827,11 +3864,11 @@ string, array, or plural.
3827
3864
 
3828
3865
 
3829
3866
 
3830
- <h5>Returns:</h5>
3867
+ <h5 class="h5-returns">Returns:</h5>
3831
3868
 
3832
3869
 
3833
3870
  <div class="param-desc">
3834
- the resource type of this resource
3871
+ true if these represent the same resource, false otherwise
3835
3872
  </div>
3836
3873
 
3837
3874
 
@@ -3842,7 +3879,8 @@ string, array, or plural.
3842
3879
  </dt>
3843
3880
  <dd>
3844
3881
 
3845
- <span class="param-type">String</span>
3882
+ <span class="param-type">boolean</span>
3883
+
3846
3884
 
3847
3885
 
3848
3886
  </dd>
@@ -3857,7 +3895,7 @@ string, array, or plural.
3857
3895
 
3858
3896
 
3859
3897
 
3860
- <h4 class="name" id="hashKey"><span class="type-signature"></span>hashKey<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
3898
+ <h4 class="name" id="setComment"><span class="type-signature"></span>setComment<span class="signature">(comment)</span><span class="type-signature"></span></h4>
3861
3899
 
3862
3900
 
3863
3901
 
@@ -3865,11 +3903,15 @@ string, array, or plural.
3865
3903
 
3866
3904
 
3867
3905
  <dl class="details">
3906
+
3907
+ <dt class="tag-description">Description:</dt>
3908
+ <dd class="tag-description"><ul class="dummy"><li>Set the translator's comment for this resource.</li></ul></dd>
3909
+
3868
3910
 
3869
3911
 
3870
3912
  <dt class="tag-source">Source:</dt>
3871
3913
  <dd class="tag-source"><ul class="dummy"><li>
3872
- <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line163">line 163</a>
3914
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line274">line 274</a>
3873
3915
  </li></ul></dd>
3874
3916
 
3875
3917
 
@@ -3880,6 +3922,11 @@ string, array, or plural.
3880
3922
 
3881
3923
 
3882
3924
 
3925
+ <dt class="tag-overrides">Overrides:</dt>
3926
+ <dd class="tag-overrides"><ul class="dummy"><li>
3927
+ <a href="Resource.html#setComment">Resource#setComment</a>
3928
+ </li></ul></dd>
3929
+
3883
3930
 
3884
3931
 
3885
3932
 
@@ -3908,9 +3955,6 @@ string, array, or plural.
3908
3955
 
3909
3956
 
3910
3957
 
3911
- <div class="description usertext">
3912
- Return the a hash key that uniquely identifies this resource.
3913
- </div>
3914
3958
 
3915
3959
 
3916
3960
 
@@ -3919,14 +3963,58 @@ string, array, or plural.
3919
3963
 
3920
3964
 
3921
3965
 
3966
+ <h5 class="h5-parameters">Parameters:</h5>
3967
+
3922
3968
 
3969
+ <table class="params">
3970
+ <thead>
3971
+ <tr>
3972
+
3973
+ <th>Name</th>
3974
+
3923
3975
 
3976
+ <th>Type</th>
3924
3977
 
3978
+
3925
3979
 
3980
+
3926
3981
 
3982
+ <th class="last">Description</th>
3983
+ </tr>
3984
+ </thead>
3927
3985
 
3986
+ <tbody>
3987
+
3928
3988
 
3989
+ <tr>
3990
+
3991
+ <td class="name"><code>comment</code></td>
3992
+
3929
3993
 
3994
+ <td class="type">
3995
+
3996
+
3997
+ <span class="param-type">String</span>
3998
+ |
3999
+
4000
+ <span class="param-type">undefined</span>
4001
+
4002
+
4003
+
4004
+
4005
+ </td>
4006
+
4007
+
4008
+
4009
+
4010
+
4011
+ <td class="description last">the translator's comment to set. Use
4012
+ undefined to clear the comment</td>
4013
+ </tr>
4014
+
4015
+
4016
+ </tbody>
4017
+ </table>
3930
4018
 
3931
4019
 
3932
4020
 
@@ -3936,28 +4024,13 @@ string, array, or plural.
3936
4024
 
3937
4025
 
3938
4026
 
3939
- <h5>Returns:</h5>
3940
4027
 
3941
-
3942
- <div class="param-desc">
3943
- a unique hash key for this resource
3944
- </div>
3945
4028
 
3946
4029
 
3947
4030
 
3948
- <dl class="param-type">
3949
- <dt>
3950
- Type
3951
- </dt>
3952
- <dd>
3953
-
3954
- <span class="param-type">String</span>
3955
4031
 
3956
4032
 
3957
- </dd>
3958
- </dl>
3959
4033
 
3960
-
3961
4034
 
3962
4035
 
3963
4036
 
@@ -3966,7 +4039,7 @@ string, array, or plural.
3966
4039
 
3967
4040
 
3968
4041
 
3969
- <h4 class="name" id="hashKeyForTranslation"><span class="type-signature"></span>hashKeyForTranslation<span class="signature">(locale)</span><span class="type-signature"> &rarr; {String}</span></h4>
4042
+ <h4 class="name" id="setProject"><span class="type-signature"></span>setProject<span class="signature">(project)</span><span class="type-signature"></span></h4>
3970
4043
 
3971
4044
 
3972
4045
 
@@ -3974,11 +4047,16 @@ string, array, or plural.
3974
4047
 
3975
4048
 
3976
4049
  <dl class="details">
4050
+
4051
+ <dt class="tag-description">Description:</dt>
4052
+ <dd class="tag-description"><ul class="dummy"><li>Set the project of this resource. This is a string that gives the
4053
+ id of the project for this resource.</li></ul></dd>
4054
+
3977
4055
 
3978
4056
 
3979
4057
  <dt class="tag-source">Source:</dt>
3980
4058
  <dd class="tag-source"><ul class="dummy"><li>
3981
- <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line175">line 175</a>
4059
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line232">line 232</a>
3982
4060
  </li></ul></dd>
3983
4061
 
3984
4062
 
@@ -3989,6 +4067,11 @@ string, array, or plural.
3989
4067
 
3990
4068
 
3991
4069
 
4070
+ <dt class="tag-overrides">Overrides:</dt>
4071
+ <dd class="tag-overrides"><ul class="dummy"><li>
4072
+ <a href="Resource.html#setProject">Resource#setProject</a>
4073
+ </li></ul></dd>
4074
+
3992
4075
 
3993
4076
 
3994
4077
 
@@ -4017,12 +4100,6 @@ string, array, or plural.
4017
4100
 
4018
4101
 
4019
4102
 
4020
- <div class="description usertext">
4021
- Return the a hash key that uniquely identifies the translation of
4022
- this resource to the given locale.
4023
- </div>
4024
-
4025
-
4026
4103
 
4027
4104
 
4028
4105
 
@@ -4031,8 +4108,7 @@ this resource to the given locale.
4031
4108
 
4032
4109
 
4033
4110
 
4034
-
4035
- <h5>Parameters:</h5>
4111
+ <h5 class="h5-parameters">Parameters:</h5>
4036
4112
 
4037
4113
 
4038
4114
  <table class="params">
@@ -4057,13 +4133,14 @@ this resource to the given locale.
4057
4133
 
4058
4134
  <tr>
4059
4135
 
4060
- <td class="name"><code>locale</code></td>
4136
+ <td class="name"><code>project</code></td>
4061
4137
 
4062
4138
 
4063
4139
  <td class="type">
4064
4140
 
4065
4141
 
4066
- <span class="param-type">String</span>
4142
+ <span class="param-type">Project</span>
4143
+
4067
4144
 
4068
4145
 
4069
4146
 
@@ -4073,7 +4150,7 @@ this resource to the given locale.
4073
4150
 
4074
4151
 
4075
4152
 
4076
- <td class="description last">a locale spec of the desired translation</td>
4153
+ <td class="description last">the project to set for this resource</td>
4077
4154
  </tr>
4078
4155
 
4079
4156
 
@@ -4095,28 +4172,6 @@ this resource to the given locale.
4095
4172
 
4096
4173
 
4097
4174
 
4098
- <h5>Returns:</h5>
4099
-
4100
-
4101
- <div class="param-desc">
4102
- a unique hash key for this resource
4103
- </div>
4104
-
4105
-
4106
-
4107
- <dl class="param-type">
4108
- <dt>
4109
- Type
4110
- </dt>
4111
- <dd>
4112
-
4113
- <span class="param-type">String</span>
4114
-
4115
-
4116
- </dd>
4117
- </dl>
4118
-
4119
-
4120
4175
 
4121
4176
 
4122
4177
 
@@ -4125,7 +4180,7 @@ this resource to the given locale.
4125
4180
 
4126
4181
 
4127
4182
 
4128
- <h4 class="name" id="isInstance"><span class="type-signature"></span>isInstance<span class="signature">(a)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
4183
+ <h4 class="name" id="setSource"><span class="type-signature"></span>setSource<span class="signature">(str)</span><span class="type-signature"></span></h4>
4129
4184
 
4130
4185
 
4131
4186
 
@@ -4133,11 +4188,16 @@ this resource to the given locale.
4133
4188
 
4134
4189
 
4135
4190
  <dl class="details">
4191
+
4192
+ <dt class="tag-description">Description:</dt>
4193
+ <dd class="tag-description"><ul class="dummy"><li>Set the source string written in the source
4194
+ locale of this resource string.</li></ul></dd>
4195
+
4136
4196
 
4137
4197
 
4138
4198
  <dt class="tag-source">Source:</dt>
4139
4199
  <dd class="tag-source"><ul class="dummy"><li>
4140
- <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line209">line 209</a>
4200
+ <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line65">line 65</a>
4141
4201
  </li></ul></dd>
4142
4202
 
4143
4203
 
@@ -4148,11 +4208,6 @@ this resource to the given locale.
4148
4208
 
4149
4209
 
4150
4210
 
4151
- <dt class="tag-overrides">Overrides:</dt>
4152
- <dd class="tag-overrides"><ul class="dummy"><li>
4153
- <a href="Resource.html#isInstance">Resource#isInstance</a>
4154
- </li></ul></dd>
4155
-
4156
4211
 
4157
4212
 
4158
4213
 
@@ -4181,12 +4236,6 @@ this resource to the given locale.
4181
4236
 
4182
4237
 
4183
4238
 
4184
- <div class="description usertext">
4185
- Check if the given resource is an instance of the current
4186
- resource.
4187
- </div>
4188
-
4189
-
4190
4239
 
4191
4240
 
4192
4241
 
@@ -4195,8 +4244,7 @@ resource.
4195
4244
 
4196
4245
 
4197
4246
 
4198
-
4199
- <h5>Parameters:</h5>
4247
+ <h5 class="h5-parameters">Parameters:</h5>
4200
4248
 
4201
4249
 
4202
4250
  <table class="params">
@@ -4221,13 +4269,14 @@ resource.
4221
4269
 
4222
4270
  <tr>
4223
4271
 
4224
- <td class="name"><code>a</code></td>
4272
+ <td class="name"><code>str</code></td>
4225
4273
 
4226
4274
 
4227
4275
  <td class="type">
4228
4276
 
4229
4277
 
4230
- <span class="param-type"><a href="Resource.html">Resource</a></span>
4278
+ <span class="param-type">String</span>
4279
+
4231
4280
 
4232
4281
 
4233
4282
 
@@ -4237,7 +4286,7 @@ resource.
4237
4286
 
4238
4287
 
4239
4288
 
4240
- <td class="description last">resource to check</td>
4289
+ <td class="description last">the source string</td>
4241
4290
  </tr>
4242
4291
 
4243
4292
 
@@ -4259,29 +4308,6 @@ resource.
4259
4308
 
4260
4309
 
4261
4310
 
4262
- <h5>Returns:</h5>
4263
-
4264
-
4265
- <div class="param-desc">
4266
- true if this is an instance of
4267
- the current resource, false otherwise.
4268
- </div>
4269
-
4270
-
4271
-
4272
- <dl class="param-type">
4273
- <dt>
4274
- Type
4275
- </dt>
4276
- <dd>
4277
-
4278
- <span class="param-type">boolean</span>
4279
-
4280
-
4281
- </dd>
4282
- </dl>
4283
-
4284
-
4285
4311
 
4286
4312
 
4287
4313
 
@@ -4290,7 +4316,7 @@ the current resource, false otherwise.
4290
4316
 
4291
4317
 
4292
4318
 
4293
- <h4 class="name" id="same"><span class="type-signature"></span>same<span class="signature">(other)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
4319
+ <h4 class="name" id="setSourceLocale"><span class="type-signature"></span>setSourceLocale<span class="signature">(locale)</span><span class="type-signature"></span></h4>
4294
4320
 
4295
4321
 
4296
4322
 
@@ -4298,11 +4324,15 @@ the current resource, false otherwise.
4298
4324
 
4299
4325
 
4300
4326
  <dl class="details">
4327
+
4328
+ <dt class="tag-description">Description:</dt>
4329
+ <dd class="tag-description"><ul class="dummy"><li>Set the source locale of this resource.</li></ul></dd>
4330
+
4301
4331
 
4302
4332
 
4303
4333
  <dt class="tag-source">Source:</dt>
4304
4334
  <dd class="tag-source"><ul class="dummy"><li>
4305
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line332">line 332</a>
4335
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line193">line 193</a>
4306
4336
  </li></ul></dd>
4307
4337
 
4308
4338
 
@@ -4315,7 +4345,7 @@ the current resource, false otherwise.
4315
4345
 
4316
4346
  <dt class="tag-overrides">Overrides:</dt>
4317
4347
  <dd class="tag-overrides"><ul class="dummy"><li>
4318
- <a href="Resource.html#same">Resource#same</a>
4348
+ <a href="Resource.html#setSourceLocale">Resource#setSourceLocale</a>
4319
4349
  </li></ul></dd>
4320
4350
 
4321
4351
 
@@ -4346,15 +4376,6 @@ the current resource, false otherwise.
4346
4376
 
4347
4377
 
4348
4378
 
4349
- <div class="description usertext">
4350
- Return true if the other resource represents the same resource as
4351
- the current one. The project, context, locale, key, flavor, and type must
4352
- match. Other fields such as the pathName, state, and comment fields are
4353
- ignored as minor variations.
4354
- </div>
4355
-
4356
-
4357
-
4358
4379
 
4359
4380
 
4360
4381
 
@@ -4363,7 +4384,7 @@ ignored as minor variations.
4363
4384
 
4364
4385
 
4365
4386
 
4366
- <h5>Parameters:</h5>
4387
+ <h5 class="h5-parameters">Parameters:</h5>
4367
4388
 
4368
4389
 
4369
4390
  <table class="params">
@@ -4388,13 +4409,14 @@ ignored as minor variations.
4388
4409
 
4389
4410
  <tr>
4390
4411
 
4391
- <td class="name"><code>other</code></td>
4412
+ <td class="name"><code>locale</code></td>
4392
4413
 
4393
4414
 
4394
4415
  <td class="type">
4395
4416
 
4396
4417
 
4397
- <span class="param-type"><a href="Resource.html">Resource</a></span>
4418
+ <span class="param-type">String</span>
4419
+
4398
4420
 
4399
4421
 
4400
4422
 
@@ -4404,7 +4426,7 @@ ignored as minor variations.
4404
4426
 
4405
4427
 
4406
4428
 
4407
- <td class="description last">another resource to test against the current one</td>
4429
+ <td class="description last">the source locale of this resource</td>
4408
4430
  </tr>
4409
4431
 
4410
4432
 
@@ -4426,28 +4448,6 @@ ignored as minor variations.
4426
4448
 
4427
4449
 
4428
4450
 
4429
- <h5>Returns:</h5>
4430
-
4431
-
4432
- <div class="param-desc">
4433
- true if these represent the same resource, false otherwise
4434
- </div>
4435
-
4436
-
4437
-
4438
- <dl class="param-type">
4439
- <dt>
4440
- Type
4441
- </dt>
4442
- <dd>
4443
-
4444
- <span class="param-type">boolean</span>
4445
-
4446
-
4447
- </dd>
4448
- </dl>
4449
-
4450
-
4451
4451
 
4452
4452
 
4453
4453
 
@@ -4456,7 +4456,7 @@ ignored as minor variations.
4456
4456
 
4457
4457
 
4458
4458
 
4459
- <h4 class="name" id="setComment"><span class="type-signature"></span>setComment<span class="signature">(comment)</span><span class="type-signature"></span></h4>
4459
+ <h4 class="name" id="setState"><span class="type-signature"></span>setState<span class="signature">(state)</span><span class="type-signature"></span></h4>
4460
4460
 
4461
4461
 
4462
4462
 
@@ -4464,11 +4464,17 @@ ignored as minor variations.
4464
4464
 
4465
4465
 
4466
4466
  <dl class="details">
4467
+
4468
+ <dt class="tag-description">Description:</dt>
4469
+ <dd class="tag-description"><ul class="dummy"><li>Set the state of this resource. This is a string that gives the
4470
+ stage of life of this resource. Currently, it can be one of "new",
4471
+ "translated", or "accepted".</li></ul></dd>
4472
+
4467
4473
 
4468
4474
 
4469
4475
  <dt class="tag-source">Source:</dt>
4470
4476
  <dd class="tag-source"><ul class="dummy"><li>
4471
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line274">line 274</a>
4477
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line243">line 243</a>
4472
4478
  </li></ul></dd>
4473
4479
 
4474
4480
 
@@ -4481,7 +4487,7 @@ ignored as minor variations.
4481
4487
 
4482
4488
  <dt class="tag-overrides">Overrides:</dt>
4483
4489
  <dd class="tag-overrides"><ul class="dummy"><li>
4484
- <a href="Resource.html#setComment">Resource#setComment</a>
4490
+ <a href="Resource.html#setState">Resource#setState</a>
4485
4491
  </li></ul></dd>
4486
4492
 
4487
4493
 
@@ -4512,11 +4518,6 @@ ignored as minor variations.
4512
4518
 
4513
4519
 
4514
4520
 
4515
- <div class="description usertext">
4516
- Set the translator's comment for this resource.
4517
- </div>
4518
-
4519
-
4520
4521
 
4521
4522
 
4522
4523
 
@@ -4525,8 +4526,7 @@ ignored as minor variations.
4525
4526
 
4526
4527
 
4527
4528
 
4528
-
4529
- <h5>Parameters:</h5>
4529
+ <h5 class="h5-parameters">Parameters:</h5>
4530
4530
 
4531
4531
 
4532
4532
  <table class="params">
@@ -4551,16 +4551,14 @@ ignored as minor variations.
4551
4551
 
4552
4552
  <tr>
4553
4553
 
4554
- <td class="name"><code>comment</code></td>
4554
+ <td class="name"><code>state</code></td>
4555
4555
 
4556
4556
 
4557
4557
  <td class="type">
4558
4558
 
4559
4559
 
4560
4560
  <span class="param-type">String</span>
4561
- |
4562
4561
 
4563
- <span class="param-type">undefined</span>
4564
4562
 
4565
4563
 
4566
4564
 
@@ -4570,8 +4568,7 @@ ignored as minor variations.
4570
4568
 
4571
4569
 
4572
4570
 
4573
- <td class="description last">the translator's comment to set. Use
4574
- undefined to clear the comment</td>
4571
+ <td class="description last">the state of this resource</td>
4575
4572
  </tr>
4576
4573
 
4577
4574
 
@@ -4601,7 +4598,7 @@ undefined to clear the comment</td>
4601
4598
 
4602
4599
 
4603
4600
 
4604
- <h4 class="name" id="setProject"><span class="type-signature"></span>setProject<span class="signature">(project)</span><span class="type-signature"></span></h4>
4601
+ <h4 class="name" id="setTarget"><span class="type-signature"></span>setTarget<span class="signature">(str)</span><span class="type-signature"></span></h4>
4605
4602
 
4606
4603
 
4607
4604
 
@@ -4609,11 +4606,15 @@ undefined to clear the comment</td>
4609
4606
 
4610
4607
 
4611
4608
  <dl class="details">
4609
+
4610
+ <dt class="tag-description">Description:</dt>
4611
+ <dd class="tag-description"><ul class="dummy"><li>Set the target string of this resource.</li></ul></dd>
4612
+
4612
4613
 
4613
4614
 
4614
4615
  <dt class="tag-source">Source:</dt>
4615
4616
  <dd class="tag-source"><ul class="dummy"><li>
4616
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line232">line 232</a>
4617
+ <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line75">line 75</a>
4617
4618
  </li></ul></dd>
4618
4619
 
4619
4620
 
@@ -4624,11 +4625,6 @@ undefined to clear the comment</td>
4624
4625
 
4625
4626
 
4626
4627
 
4627
- <dt class="tag-overrides">Overrides:</dt>
4628
- <dd class="tag-overrides"><ul class="dummy"><li>
4629
- <a href="Resource.html#setProject">Resource#setProject</a>
4630
- </li></ul></dd>
4631
-
4632
4628
 
4633
4629
 
4634
4630
 
@@ -4657,13 +4653,6 @@ undefined to clear the comment</td>
4657
4653
 
4658
4654
 
4659
4655
 
4660
- <div class="description usertext">
4661
- Set the project of this resource. This is a string that gives the
4662
- id of the project for this resource.
4663
- </div>
4664
-
4665
-
4666
-
4667
4656
 
4668
4657
 
4669
4658
 
@@ -4672,7 +4661,7 @@ id of the project for this resource.
4672
4661
 
4673
4662
 
4674
4663
 
4675
- <h5>Parameters:</h5>
4664
+ <h5 class="h5-parameters">Parameters:</h5>
4676
4665
 
4677
4666
 
4678
4667
  <table class="params">
@@ -4697,13 +4686,14 @@ id of the project for this resource.
4697
4686
 
4698
4687
  <tr>
4699
4688
 
4700
- <td class="name"><code>project</code></td>
4689
+ <td class="name"><code>str</code></td>
4701
4690
 
4702
4691
 
4703
4692
  <td class="type">
4704
4693
 
4705
4694
 
4706
- <span class="param-type">Project</span>
4695
+ <span class="param-type">String</span>
4696
+
4707
4697
 
4708
4698
 
4709
4699
 
@@ -4713,7 +4703,7 @@ id of the project for this resource.
4713
4703
 
4714
4704
 
4715
4705
 
4716
- <td class="description last">the project to set for this resource</td>
4706
+ <td class="description last">the target string</td>
4717
4707
  </tr>
4718
4708
 
4719
4709
 
@@ -4743,7 +4733,7 @@ id of the project for this resource.
4743
4733
 
4744
4734
 
4745
4735
 
4746
- <h4 class="name" id="setSource"><span class="type-signature"></span>setSource<span class="signature">(str)</span><span class="type-signature"></span></h4>
4736
+ <h4 class="name" id="setTargetLocale"><span class="type-signature"></span>setTargetLocale<span class="signature">(locale)</span><span class="type-signature"></span></h4>
4747
4737
 
4748
4738
 
4749
4739
 
@@ -4751,11 +4741,15 @@ id of the project for this resource.
4751
4741
 
4752
4742
 
4753
4743
  <dl class="details">
4744
+
4745
+ <dt class="tag-description">Description:</dt>
4746
+ <dd class="tag-description"><ul class="dummy"><li>Set the target locale of this resource.</li></ul></dd>
4747
+
4754
4748
 
4755
4749
 
4756
4750
  <dt class="tag-source">Source:</dt>
4757
4751
  <dd class="tag-source"><ul class="dummy"><li>
4758
- <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line65">line 65</a>
4752
+ <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line211">line 211</a>
4759
4753
  </li></ul></dd>
4760
4754
 
4761
4755
 
@@ -4766,6 +4760,11 @@ id of the project for this resource.
4766
4760
 
4767
4761
 
4768
4762
 
4763
+ <dt class="tag-overrides">Overrides:</dt>
4764
+ <dd class="tag-overrides"><ul class="dummy"><li>
4765
+ <a href="Resource.html#setTargetLocale">Resource#setTargetLocale</a>
4766
+ </li></ul></dd>
4767
+
4769
4768
 
4770
4769
 
4771
4770
 
@@ -4794,12 +4793,6 @@ id of the project for this resource.
4794
4793
 
4795
4794
 
4796
4795
 
4797
- <div class="description usertext">
4798
- Set the source string written in the source
4799
- locale of this resource string.
4800
- </div>
4801
-
4802
-
4803
4796
 
4804
4797
 
4805
4798
 
@@ -4808,8 +4801,7 @@ locale of this resource string.
4808
4801
 
4809
4802
 
4810
4803
 
4811
-
4812
- <h5>Parameters:</h5>
4804
+ <h5 class="h5-parameters">Parameters:</h5>
4813
4805
 
4814
4806
 
4815
4807
  <table class="params">
@@ -4834,7 +4826,7 @@ locale of this resource string.
4834
4826
 
4835
4827
  <tr>
4836
4828
 
4837
- <td class="name"><code>str</code></td>
4829
+ <td class="name"><code>locale</code></td>
4838
4830
 
4839
4831
 
4840
4832
  <td class="type">
@@ -4843,6 +4835,7 @@ locale of this resource string.
4843
4835
  <span class="param-type">String</span>
4844
4836
 
4845
4837
 
4838
+
4846
4839
 
4847
4840
  </td>
4848
4841
 
@@ -4850,7 +4843,7 @@ locale of this resource string.
4850
4843
 
4851
4844
 
4852
4845
 
4853
- <td class="description last">the source string</td>
4846
+ <td class="description last">the target locale of this resource</td>
4854
4847
  </tr>
4855
4848
 
4856
4849
 
@@ -4880,7 +4873,7 @@ locale of this resource string.
4880
4873
 
4881
4874
 
4882
4875
 
4883
- <h4 class="name" id="setSourceLocale"><span class="type-signature"></span>setSourceLocale<span class="signature">(locale)</span><span class="type-signature"></span></h4>
4876
+ <h4 class="name" id="size"><span class="type-signature"></span>size<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
4884
4877
 
4885
4878
 
4886
4879
 
@@ -4888,11 +4881,15 @@ locale of this resource string.
4888
4881
 
4889
4882
 
4890
4883
  <dl class="details">
4884
+
4885
+ <dt class="tag-description">Description:</dt>
4886
+ <dd class="tag-description"><ul class="dummy"><li>Return the number of strings in this resource.</li></ul></dd>
4887
+
4891
4888
 
4892
4889
 
4893
4890
  <dt class="tag-source">Source:</dt>
4894
4891
  <dd class="tag-source"><ul class="dummy"><li>
4895
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line193">line 193</a>
4892
+ <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line85">line 85</a>
4896
4893
  </li></ul></dd>
4897
4894
 
4898
4895
 
@@ -4903,11 +4900,6 @@ locale of this resource string.
4903
4900
 
4904
4901
 
4905
4902
 
4906
- <dt class="tag-overrides">Overrides:</dt>
4907
- <dd class="tag-overrides"><ul class="dummy"><li>
4908
- <a href="Resource.html#setSourceLocale">Resource#setSourceLocale</a>
4909
- </li></ul></dd>
4910
-
4911
4903
 
4912
4904
 
4913
4905
 
@@ -4936,9 +4928,6 @@ locale of this resource string.
4936
4928
 
4937
4929
 
4938
4930
 
4939
- <div class="description usertext">
4940
- Set the source locale of this resource.
4941
- </div>
4942
4931
 
4943
4932
 
4944
4933
 
@@ -4950,53 +4939,9 @@ locale of this resource string.
4950
4939
 
4951
4940
 
4952
4941
 
4953
- <h5>Parameters:</h5>
4954
-
4955
4942
 
4956
- <table class="params">
4957
- <thead>
4958
- <tr>
4959
-
4960
- <th>Name</th>
4961
-
4962
4943
 
4963
- <th>Type</th>
4964
4944
 
4965
-
4966
-
4967
-
4968
-
4969
- <th class="last">Description</th>
4970
- </tr>
4971
- </thead>
4972
-
4973
- <tbody>
4974
-
4975
-
4976
- <tr>
4977
-
4978
- <td class="name"><code>locale</code></td>
4979
-
4980
-
4981
- <td class="type">
4982
-
4983
-
4984
- <span class="param-type">String</span>
4985
-
4986
-
4987
-
4988
- </td>
4989
-
4990
-
4991
-
4992
-
4993
-
4994
- <td class="description last">the source locale of this resource</td>
4995
- </tr>
4996
-
4997
-
4998
- </tbody>
4999
- </table>
5000
4945
 
5001
4946
 
5002
4947
 
@@ -5005,14 +4950,29 @@ locale of this resource string.
5005
4950
 
5006
4951
 
5007
4952
 
4953
+ <h5 class="h5-returns">Returns:</h5>
5008
4954
 
4955
+
4956
+ <div class="param-desc">
4957
+ the number of strings in this resource
4958
+ </div>
5009
4959
 
5010
4960
 
5011
4961
 
4962
+ <dl class="param-type">
4963
+ <dt>
4964
+ Type
4965
+ </dt>
4966
+ <dd>
4967
+
4968
+ <span class="param-type">number</span>
5012
4969
 
5013
4970
 
5014
4971
 
4972
+ </dd>
4973
+ </dl>
5015
4974
 
4975
+
5016
4976
 
5017
4977
 
5018
4978
 
@@ -5021,7 +4981,7 @@ locale of this resource string.
5021
4981
 
5022
4982
 
5023
4983
 
5024
- <h4 class="name" id="setState"><span class="type-signature"></span>setState<span class="signature">(state)</span><span class="type-signature"></span></h4>
4984
+ <h4 class="name" id=".cleanHashKey"><span class="type-signature type-signature-static">(static) </span>cleanHashKey<span class="signature">(project, locale, reskey, datatype, flavor, context)</span><span class="type-signature"> &rarr; {String}</span></h4>
5025
4985
 
5026
4986
 
5027
4987
 
@@ -5029,11 +4989,16 @@ locale of this resource string.
5029
4989
 
5030
4990
 
5031
4991
  <dl class="details">
4992
+
4993
+ <dt class="tag-description">Description:</dt>
4994
+ <dd class="tag-description"><ul class="dummy"><li>Calculate a resource key string for this class of resource given the
4995
+ parameters.</li></ul></dd>
4996
+
5032
4997
 
5033
4998
 
5034
4999
  <dt class="tag-source">Source:</dt>
5035
5000
  <dd class="tag-source"><ul class="dummy"><li>
5036
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line243">line 243</a>
5001
+ <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line151">line 151</a>
5037
5002
  </li></ul></dd>
5038
5003
 
5039
5004
 
@@ -5044,11 +5009,6 @@ locale of this resource string.
5044
5009
 
5045
5010
 
5046
5011
 
5047
- <dt class="tag-overrides">Overrides:</dt>
5048
- <dd class="tag-overrides"><ul class="dummy"><li>
5049
- <a href="Resource.html#setState">Resource#setState</a>
5050
- </li></ul></dd>
5051
-
5052
5012
 
5053
5013
 
5054
5014
 
@@ -5077,13 +5037,6 @@ locale of this resource string.
5077
5037
 
5078
5038
 
5079
5039
 
5080
- <div class="description usertext">
5081
- Set the state of this resource. This is a string that gives the
5082
- stage of life of this resource. Currently, it can be one of "new",
5083
- "translated", or "accepted".
5084
- </div>
5085
-
5086
-
5087
5040
 
5088
5041
 
5089
5042
 
@@ -5092,8 +5045,7 @@ stage of life of this resource. Currently, it can be one of "new",
5092
5045
 
5093
5046
 
5094
5047
 
5095
-
5096
- <h5>Parameters:</h5>
5048
+ <h5 class="h5-parameters">Parameters:</h5>
5097
5049
 
5098
5050
 
5099
5051
  <table class="params">
@@ -5118,7 +5070,7 @@ stage of life of this resource. Currently, it can be one of "new",
5118
5070
 
5119
5071
  <tr>
5120
5072
 
5121
- <td class="name"><code>state</code></td>
5073
+ <td class="name"><code>project</code></td>
5122
5074
 
5123
5075
 
5124
5076
  <td class="type">
@@ -5127,6 +5079,7 @@ stage of life of this resource. Currently, it can be one of "new",
5127
5079
  <span class="param-type">String</span>
5128
5080
 
5129
5081
 
5082
+
5130
5083
 
5131
5084
  </td>
5132
5085
 
@@ -5134,127 +5087,110 @@ stage of life of this resource. Currently, it can be one of "new",
5134
5087
 
5135
5088
 
5136
5089
 
5137
- <td class="description last">the state of this resource</td>
5090
+ <td class="description last">the project of the string</td>
5138
5091
  </tr>
5139
5092
 
5140
5093
 
5141
- </tbody>
5142
- </table>
5143
-
5144
-
5145
-
5146
-
5147
-
5148
-
5149
-
5150
-
5151
-
5152
-
5153
-
5154
-
5155
-
5156
5094
 
5095
+ <tr>
5096
+
5097
+ <td class="name"><code>locale</code></td>
5098
+
5157
5099
 
5100
+ <td class="type">
5101
+
5102
+
5103
+ <span class="param-type">String</span>
5158
5104
 
5159
5105
 
5160
5106
 
5107
+
5108
+ </td>
5161
5109
 
5162
-
5163
5110
 
5164
5111
 
5165
-
5112
+
5166
5113
 
5167
- <h4 class="name" id="setTarget"><span class="type-signature"></span>setTarget<span class="signature">(str)</span><span class="type-signature"></span></h4>
5114
+ <td class="description last">the locale of the string</td>
5115
+ </tr>
5168
5116
 
5169
5117
 
5170
5118
 
5119
+ <tr>
5120
+
5121
+ <td class="name"><code>reskey</code></td>
5122
+
5171
5123
 
5124
+ <td class="type">
5125
+
5126
+
5127
+ <span class="param-type">String</span>
5172
5128
 
5173
5129
 
5174
- <dl class="details">
5175
-
5176
-
5177
- <dt class="tag-source">Source:</dt>
5178
- <dd class="tag-source"><ul class="dummy"><li>
5179
- <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line75">line 75</a>
5180
- </li></ul></dd>
5181
-
5182
-
5183
-
5184
5130
 
5185
-
5131
+
5132
+ </td>
5186
5133
 
5187
-
5134
+
5188
5135
 
5189
-
5136
+
5190
5137
 
5191
-
5138
+ <td class="description last">the key of the string</td>
5139
+ </tr>
5192
5140
 
5193
5141
 
5194
5142
 
5195
-
5143
+ <tr>
5144
+
5145
+ <td class="name"><code>datatype</code></td>
5146
+
5196
5147
 
5197
-
5148
+ <td class="type">
5149
+
5150
+
5151
+ <span class="param-type">String</span>
5198
5152
 
5199
-
5200
5153
 
5201
-
5202
5154
 
5203
-
5155
+
5156
+ </td>
5204
5157
 
5205
-
5158
+
5206
5159
 
5207
-
5160
+
5208
5161
 
5209
-
5162
+ <td class="description last">the datatype of the string</td>
5163
+ </tr>
5210
5164
 
5211
5165
 
5212
- </dl>
5213
-
5214
-
5215
-
5216
-
5217
-
5218
- <div class="description usertext">
5219
- Set the target string of this resource.
5220
- </div>
5221
-
5222
-
5223
-
5224
-
5225
-
5226
-
5227
-
5228
-
5229
5166
 
5167
+ <tr>
5168
+
5169
+ <td class="name"><code>flavor</code></td>
5170
+
5230
5171
 
5172
+ <td class="type">
5173
+
5174
+
5175
+ <span class="param-type">String</span>
5231
5176
 
5232
- <h5>Parameters:</h5>
5233
-
5234
5177
 
5235
- <table class="params">
5236
- <thead>
5237
- <tr>
5238
-
5239
- <th>Name</th>
5240
-
5241
5178
 
5242
- <th>Type</th>
5179
+
5180
+ </td>
5243
5181
 
5244
-
5182
+
5245
5183
 
5246
-
5184
+
5247
5185
 
5248
- <th class="last">Description</th>
5249
- </tr>
5250
- </thead>
5186
+ <td class="description last">the flavor of the string</td>
5187
+ </tr>
5251
5188
 
5252
- <tbody>
5253
5189
 
5254
5190
 
5255
5191
  <tr>
5256
5192
 
5257
- <td class="name"><code>str</code></td>
5193
+ <td class="name"><code>context</code></td>
5258
5194
 
5259
5195
 
5260
5196
  <td class="type">
@@ -5263,6 +5199,7 @@ stage of life of this resource. Currently, it can be one of "new",
5263
5199
  <span class="param-type">String</span>
5264
5200
 
5265
5201
 
5202
+
5266
5203
 
5267
5204
  </td>
5268
5205
 
@@ -5270,7 +5207,7 @@ stage of life of this resource. Currently, it can be one of "new",
5270
5207
 
5271
5208
 
5272
5209
 
5273
- <td class="description last">the target string</td>
5210
+ <td class="description last">the context of the string</td>
5274
5211
  </tr>
5275
5212
 
5276
5213
 
@@ -5292,6 +5229,29 @@ stage of life of this resource. Currently, it can be one of "new",
5292
5229
 
5293
5230
 
5294
5231
 
5232
+ <h5 class="h5-returns">Returns:</h5>
5233
+
5234
+
5235
+ <div class="param-desc">
5236
+ a hash key
5237
+ </div>
5238
+
5239
+
5240
+
5241
+ <dl class="param-type">
5242
+ <dt>
5243
+ Type
5244
+ </dt>
5245
+ <dd>
5246
+
5247
+ <span class="param-type">String</span>
5248
+
5249
+
5250
+
5251
+ </dd>
5252
+ </dl>
5253
+
5254
+
5295
5255
 
5296
5256
 
5297
5257
 
@@ -5300,7 +5260,7 @@ stage of life of this resource. Currently, it can be one of "new",
5300
5260
 
5301
5261
 
5302
5262
 
5303
- <h4 class="name" id="setTargetLocale"><span class="type-signature"></span>setTargetLocale<span class="signature">(locale)</span><span class="type-signature"></span></h4>
5263
+ <h4 class="name" id=".hashKey"><span class="type-signature type-signature-static">(static) </span>hashKey<span class="signature">(project, locale, reskey, datatype, flavor, context)</span><span class="type-signature"> &rarr; {String}</span></h4>
5304
5264
 
5305
5265
 
5306
5266
 
@@ -5308,11 +5268,16 @@ stage of life of this resource. Currently, it can be one of "new",
5308
5268
 
5309
5269
 
5310
5270
  <dl class="details">
5271
+
5272
+ <dt class="tag-description">Description:</dt>
5273
+ <dd class="tag-description"><ul class="dummy"><li>Calculate a resource key string for this class of resource given the
5274
+ parameters.</li></ul></dd>
5275
+
5311
5276
 
5312
5277
 
5313
5278
  <dt class="tag-source">Source:</dt>
5314
5279
  <dd class="tag-source"><ul class="dummy"><li>
5315
- <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line211">line 211</a>
5280
+ <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line132">line 132</a>
5316
5281
  </li></ul></dd>
5317
5282
 
5318
5283
 
@@ -5323,11 +5288,6 @@ stage of life of this resource. Currently, it can be one of "new",
5323
5288
 
5324
5289
 
5325
5290
 
5326
- <dt class="tag-overrides">Overrides:</dt>
5327
- <dd class="tag-overrides"><ul class="dummy"><li>
5328
- <a href="Resource.html#setTargetLocale">Resource#setTargetLocale</a>
5329
- </li></ul></dd>
5330
-
5331
5291
 
5332
5292
 
5333
5293
 
@@ -5356,10 +5316,6 @@ stage of life of this resource. Currently, it can be one of "new",
5356
5316
 
5357
5317
 
5358
5318
 
5359
- <div class="description usertext">
5360
- Set the target locale of this resource.
5361
- </div>
5362
-
5363
5319
 
5364
5320
 
5365
5321
 
@@ -5368,9 +5324,7 @@ stage of life of this resource. Currently, it can be one of "new",
5368
5324
 
5369
5325
 
5370
5326
 
5371
-
5372
-
5373
- <h5>Parameters:</h5>
5327
+ <h5 class="h5-parameters">Parameters:</h5>
5374
5328
 
5375
5329
 
5376
5330
  <table class="params">
@@ -5395,7 +5349,7 @@ stage of life of this resource. Currently, it can be one of "new",
5395
5349
 
5396
5350
  <tr>
5397
5351
 
5398
- <td class="name"><code>locale</code></td>
5352
+ <td class="name"><code>project</code></td>
5399
5353
 
5400
5354
 
5401
5355
  <td class="type">
@@ -5404,6 +5358,7 @@ stage of life of this resource. Currently, it can be one of "new",
5404
5358
  <span class="param-type">String</span>
5405
5359
 
5406
5360
 
5361
+
5407
5362
 
5408
5363
  </td>
5409
5364
 
@@ -5411,99 +5366,132 @@ stage of life of this resource. Currently, it can be one of "new",
5411
5366
 
5412
5367
 
5413
5368
 
5414
- <td class="description last">the target locale of this resource</td>
5369
+ <td class="description last">the project of the string</td>
5415
5370
  </tr>
5416
5371
 
5417
5372
 
5418
- </tbody>
5419
- </table>
5420
-
5421
-
5422
-
5423
-
5424
5373
 
5374
+ <tr>
5375
+
5376
+ <td class="name"><code>locale</code></td>
5377
+
5425
5378
 
5379
+ <td class="type">
5380
+
5381
+
5382
+ <span class="param-type">String</span>
5426
5383
 
5427
5384
 
5428
5385
 
5386
+
5387
+ </td>
5429
5388
 
5389
+
5430
5390
 
5391
+
5431
5392
 
5393
+ <td class="description last">the locale of the string</td>
5394
+ </tr>
5432
5395
 
5396
+
5433
5397
 
5398
+ <tr>
5399
+
5400
+ <td class="name"><code>reskey</code></td>
5401
+
5434
5402
 
5403
+ <td class="type">
5404
+
5405
+
5406
+ <span class="param-type">String</span>
5435
5407
 
5436
5408
 
5437
5409
 
5410
+
5411
+ </td>
5438
5412
 
5439
-
5440
5413
 
5441
5414
 
5442
-
5415
+
5443
5416
 
5444
- <h4 class="name" id="size"><span class="type-signature"></span>size<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
5417
+ <td class="description last">the key of the string</td>
5418
+ </tr>
5445
5419
 
5446
5420
 
5447
5421
 
5422
+ <tr>
5423
+
5424
+ <td class="name"><code>datatype</code></td>
5425
+
5448
5426
 
5427
+ <td class="type">
5428
+
5429
+
5430
+ <span class="param-type">String</span>
5449
5431
 
5450
5432
 
5451
- <dl class="details">
5452
-
5453
-
5454
- <dt class="tag-source">Source:</dt>
5455
- <dd class="tag-source"><ul class="dummy"><li>
5456
- <a href="ResourceString.js.html">ResourceString.js</a>, <a href="ResourceString.js.html#line85">line 85</a>
5457
- </li></ul></dd>
5458
-
5459
5433
 
5460
-
5434
+
5435
+ </td>
5461
5436
 
5462
-
5437
+
5463
5438
 
5464
-
5439
+
5465
5440
 
5466
-
5441
+ <td class="description last">the datatype of the string</td>
5442
+ </tr>
5467
5443
 
5468
5444
 
5469
5445
 
5470
-
5446
+ <tr>
5447
+
5448
+ <td class="name"><code>flavor</code></td>
5449
+
5471
5450
 
5472
-
5451
+ <td class="type">
5452
+
5453
+
5454
+ <span class="param-type">String</span>
5473
5455
 
5474
-
5475
5456
 
5476
-
5477
5457
 
5478
-
5458
+
5459
+ </td>
5479
5460
 
5480
-
5461
+
5481
5462
 
5482
-
5463
+
5483
5464
 
5484
-
5465
+ <td class="description last">the flavor of the string</td>
5466
+ </tr>
5485
5467
 
5486
5468
 
5487
5469
 
5488
-
5489
- </dl>
5490
-
5491
-
5492
-
5493
-
5494
-
5495
- <div class="description usertext">
5496
- Return the number of strings in this resource.
5497
- </div>
5498
-
5470
+ <tr>
5471
+
5472
+ <td class="name"><code>context</code></td>
5473
+
5499
5474
 
5475
+ <td class="type">
5476
+
5477
+
5478
+ <span class="param-type">String</span>
5500
5479
 
5501
5480
 
5502
5481
 
5482
+
5483
+ </td>
5503
5484
 
5485
+
5504
5486
 
5487
+
5505
5488
 
5489
+ <td class="description last">the context of the string</td>
5490
+ </tr>
5506
5491
 
5492
+
5493
+ </tbody>
5494
+ </table>
5507
5495
 
5508
5496
 
5509
5497
 
@@ -5520,11 +5508,11 @@ stage of life of this resource. Currently, it can be one of "new",
5520
5508
 
5521
5509
 
5522
5510
 
5523
- <h5>Returns:</h5>
5511
+ <h5 class="h5-returns">Returns:</h5>
5524
5512
 
5525
5513
 
5526
5514
  <div class="param-desc">
5527
- the number of strings in this resource
5515
+ a hash key
5528
5516
  </div>
5529
5517
 
5530
5518
 
@@ -5535,7 +5523,8 @@ stage of life of this resource. Currently, it can be one of "new",
5535
5523
  </dt>
5536
5524
  <dd>
5537
5525
 
5538
- <span class="param-type">number</span>
5526
+ <span class="param-type">String</span>
5527
+
5539
5528
 
5540
5529
 
5541
5530
  </dd>
@@ -5565,7 +5554,7 @@ stage of life of this resource. Currently, it can be one of "new",
5565
5554
  <br class="clear">
5566
5555
 
5567
5556
  <footer>
5568
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sun Dec 11 2022 21:08:55 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
5557
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Tue Jan 24 2023 22:21:49 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
5569
5558
  </footer>
5570
5559
 
5571
5560
  <script>prettyPrint();</script>