Currently it is not possible to add documentation for messages in a message bundle.
The current syntax requires that the values for the keys always be strings.
{ "@metadata": { ... }, "pageTitle": "title of the page", "description": "description of the page", "translationUnits": "these are translation units", "footer": "footer of the page" }
The updated syntax could be as follows:
{ "@metadata": { }, "pageTitle": { "value": "title of the page", "qqq": "This is the title of the page." }, "description": "description of the page", "translationUnits": "these are translation units", "footer": "footer of the page" }
In the update syntax, pageTitle key is now an object with two properties: value for the source string and qqq for the message documentation for the string.