FLUID-5326: Clean up "fluid-tags" Infusion API docs generator and make it easy to run

Metadata

Source
FLUID-5326
Type
Improvement
Priority
Blocker
Status
Closed
Resolution
Fixed
Assignee
Steven Githens
Reporter
Simon Bates
Created
2014-04-25T14:23:17.796-0400
Updated
2014-07-07T15:12:18.178-0400
Versions
N/A
Fixed Versions
  1. 1.5
Component
  1. Tech. Documentation

Description

We would like to try out the fluid-tags tool for the Fluid 1.5 API docs:
https://github.com/sgithens/lichen

The tool can generate HTML documentation from JavaScript source code.

The scope of this ticket is to make any changes needed to fluid-tags to make it conveniently runnable.

Comments

  • Justin Obara commented 2014-05-02T10:56:06.869-0400

    Would it be possible to rename this tool? I feel that the term "tags" will be a bit overloaded with notion of git tags for the Infusion source code.

  • Simon Bates commented 2014-05-26T12:01:38.853-0400

    The tool is now ready to use.

    From Steve:

    https://github.com/sgithens/lichen

    The README should have everything you need to try it out.