GEEKING

2026-09-05 05:07:48 +00:00 · 2025-09-18 17:55:52 -04:00
commit 977f1ff4b8
15030 changed files with 17324420 additions and 0 deletions
@@ -0,0 +1,31 @@
+/**
+    @overview Adds support for reusable partial jsdoc files.
+    @module plugins/partial
+    @author Ludo Antonov <ludo@hulu.com>
+ */
+'use strict';
+
+var fs = require('jsdoc/fs');
+var path = require('path');
+
+exports.handlers = {
+    /**
+     * Include a partial jsdoc
+     *
+     * @param e
+     * @param e.filename
+     * @param e.source
+     * @example
+     *     @partial "partial_doc.jsdoc"
+     */
+    beforeParse: function(e) {
+        e.source = e.source.replace(/(@partial \".*\")+/g, function($) {
+            var pathArg = $.match(/\".*\"/)[0].replace(/"/g, '');
+            var fullPath = path.join(e.filename, '..', pathArg);
+
+            var partialData = fs.readFileSync(fullPath, global.env.opts.encoding);
+
+            return partialData;
+        });
+    }
+};