Merge 2b3ec76 into a544986

src/annotation/annotations/group.js

@@ -2,8 +2,15 @@ export default function group () {
   return {
     name: 'group',
 
-    parse (text) {
-      return [text.trim().toLowerCase()]
+    parse (text, info) {
+      let lines = text.trim().split('\n')
+      let slug = lines[0].trim().toLowerCase()
+      let description = lines.splice(1).join('\n').trim()
+      if (description) {
+        info.groupDescriptions = info.groupDescriptions || {}
+        info.groupDescriptions[slug] = description
+      }
+      return [slug]
     },
 
     default () {

src/annotation/annotations/groupDescription.js

@@ -0,0 +1,21 @@
+/**
+ * `@groupDescriptions` is should not be used on its own.
+ *
+ * It gets filled automatically from the lines following the `@group` annotation.
+ *
+ * @group example
+ * This is a group description. It describes the group.
+ * It can be split across multiple lines.
+ *
+ * {
+ *   'groupDescriptions': {
+ *     'example': 'This is a group description. It describes the group.\nIt can be split across multiple lines.'
+ *   }
+ * }
+ */
+
+export default function groupDescriptions () {
+  return {
+    name: 'groupDescriptions',
+  }
+}

src/annotation/annotations/index.js

@@ -6,6 +6,7 @@ module.exports = [
   require('./deprecated.js').default,
   require('./example.js').default,
   require('./group.js').default,
+  require('./groupDescription.js').default,
   require('./ignore.js').default,
   require('./link.js').default,
   require('./name.js').default,

test/annotations/api.test.js

@@ -9,7 +9,7 @@ describe('#AnnotationsApi', function () {
   it('should include the right number of annotations', function () {
     assert.equal(
       Object.keys(api.list).length,
-      21
+      22
     )
   })
 })

test/annotations/group.test.js

@@ -10,4 +10,12 @@ describe('#group', function () {
     assert.deepEqual(group.parse('group'), ['group'])
     assert.deepEqual(group.parse('GRoup'), ['group'])
   })
+
+  it('should parse a description from subsequent lines', function () {
+    var item = {}
+    assert.deepEqual(group.parse('group\ndescription', item), ['group'])
+    assert.deepEqual(item, {'groupDescriptions': {
+      'group': 'description'
+    }})
+  })
 })