summaryrefslogtreecommitdiffstats
path: root/packages/gitbook-html/lib/glossary.js
diff options
context:
space:
mode:
Diffstat (limited to 'packages/gitbook-html/lib/glossary.js')
-rwxr-xr-xpackages/gitbook-html/lib/glossary.js7
1 files changed, 6 insertions, 1 deletions
diff --git a/packages/gitbook-html/lib/glossary.js b/packages/gitbook-html/lib/glossary.js
index 89ff135..26787ab 100755
--- a/packages/gitbook-html/lib/glossary.js
+++ b/packages/gitbook-html/lib/glossary.js
@@ -1,7 +1,12 @@
var _ = require('lodash');
var dom = require('./dom');
-// HTML -> Glossary
+/**
+ Parse an HTML content into a list of glossary entry
+
+ @param {String} html
+ @return {Array}
+*/
function parseGlossary(html) {
var $ = dom.parse(html);