From 5cb6bb4cd1e33af825b28070b1efe6a3cde7786a Mon Sep 17 00:00:00 2001 From: Michael Mathews Date: Tue, 29 May 2012 20:32:34 +0100 Subject: [PATCH] Updates to the Haruki README, added contact info. --- templates/haruki/README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/templates/haruki/README.md b/templates/haruki/README.md index 087df6c8..ee6d36f1 100644 --- a/templates/haruki/README.md +++ b/templates/haruki/README.md @@ -1,7 +1,7 @@ OVERVIEW ======== -JSDoc 3 Haruki is an experimental template optimised for use with publishing processes that consume either JSON or XML. Whereas the default JSDoc template outputs an HTML representation of your docs, Haruki will output a JSON, or optionally an XML, representation. +JSDoc 3 Haruki is an experimental template optimised for use with publishing processes that consume either JSON or XML. Whereas the default JSDoc template outputs an HTML representation of your API, Haruki will output a JSON, or optionally an XML, representation. Currently Haruki only supports a subset of the tags supported by the default template. Those are: @@ -9,8 +9,8 @@ Currently Haruki only supports a subset of the tags supported by the default tem * @desc * @type * @namespace - * @function (or @method) - * @var (or @member) + * @method (or @function) + * @member (or @var) * @class * @mixin * @event @@ -20,6 +20,8 @@ Currently Haruki only supports a subset of the tags supported by the default tem * @example * @access (like @private or @public) +This limited support set is intentional, as it is meant to be a usable set that could be shared with either JavaScript or PHP documentation -- another experimental tool, named "Vonnegut", can produce Haruki compatible JSON from PHPDoc tags. + Note: `@link`s will appear in the output untransformed, there is no way to know at this stage what the file layout of your output will eventually be. It is assumed that whatever process emits the final output file/s will transform `@link` tags at that point. USAGE @@ -27,4 +29,11 @@ USAGE ./jsdoc myscript.js -t templates/haruki -d console -q format=xml -The results of this command will appear in `stdout` and can be piped into other tools for further processing. \ No newline at end of file +The results of this command will appear in `stdout` and can be piped into other tools for further processing. + +MORE +===== + +If you are interested in Haruki, you are encouraged to discuss your questions or ideas on the JSDoc-Users mailing list and fork/contribute to this project. + +For more information contact Michael Mathews at . \ No newline at end of file