Uploaded image for project: 'Alloy'
  1. Alloy
  2. ALOY-199

Documentation: Make Alloy safe for documentation

    Details

    • Type: Story
    • Status: Resolved
    • Priority: High
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None

      Description

      To build the Alloy docs using JSDuck, we need to comment the classes that should be exposed, and remove any comments that look like doc comments--that is if we do this:

      /**
       * Do something here.
       */
       exports._ = function() ...
      

      JSDuck will add a global method called "_" with the description "Do something here." Changing the doc comment intro /** into a regular comment intro /* eliminates the rogue method.

      Currently, it looks like we should be building docs from Alloy/builtins and Alloy/lib.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              aevans Arthur Evans
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Backbone Issue Sync

                • Backbone Issue Sync is enabled for your project, but we do not have any synchronization info for this issue.

                  Git Integration