Uploaded image for project: 'AeroGear'
  1. AeroGear
  2. AEROGEAR-957

JS: doc: cleanup, example writing and completeness

    XMLWordPrintable

Details

    • Feature Request
    • Resolution: Done
    • Major
    • 1.0.0
    • 1.0.0.M8
    • javascript
    • None

    Description

      I guess the JS Doc needs a bit more explanation/detailed love

      Looking here:
      http://aerogear.org/docs/specs/aerogear-js/AeroGear.Pipeline.html

      I think (for instance) it's not really clear what this means:

      add(config) → {Object}
      

      Even if the page has some doc on the config object, it's not clear that this (especially the settings) are 'valid' to use:

      ...
      name: "projects",
      settings: {
                  agAuth: true,
                  baseURL: "/todo-server/",
                  endpoints: {
                      enroll: "auth/register"
                  }
              }
      ...
      

      I think this is true for other modules/functions as well

      Attachments

        Activity

          People

            kborchers Kris Borchers (Inactive)
            mwessend@redhat.com Matthias Wessendorf
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: