Skip to content

API doc notes

Rand McKinney edited this page Mar 14, 2014 · 12 revisions

Changes on 3/12/14:

  • Updated a bunch of .js files to fix formatting. See commit.
  • Copied content from markdown files in LoopBack repo into JSDoc comments in this repo:
  • Reformatted docs.json and moved the following from docs.json:
    • hooks.js
    • types.js

Missing Stuff

  • Many of the validation functions in validations.js don't have @params.
  • Comments at beginnning of loopback/lib/acl.js are not being parsed properly. Are the things like accessType and permission properties? There appear to be other issues re JSDoc comments in this file.

Other questions

  • Why is ModelClass.registerProperty() included in ModelBuilder.js. Should it be part of it's own class API doc?
  • Is defineReadonlyProp() a method of DataAccessObject? It doesn't appear to be defined that way? Is it just an internal function that shouldn't be documented?
  • I'm a bit confused about what stuff should go into the API doc for LoopBack and what should go into LoopBack DataSource Juggler.
Clone this wiki locally