git.roojs.org Git - xtuple/blob - scripts/jsdoc_README.md

   1 This is the API documentation for the framework code on
   2 the client of the xTuple Web/Mobile platform. It does not
   3 include database or datasource code, nor does it include
   4 business-object-specific implementation classes.
   5
   6 These objects are in one of three namespaces:
   7
   8 * `XV`: views, typically defined in `lib/enyo-x`
   9 * `XM`: models, typically defined in `lib/backbone-x`
  10 * `XT`: tools, typically defined in `lib/tools`
  11
  12 You can see a filtered list of the objects by namespace
  13 by clicking on the namespace links at the bottom of the
  14 sidebar.
  15
  16 See our [architectual overview](https://github.com/xtuple/xtuple/wiki/Overview)
  17 for a more detailed description.