jsdoc.json

{
  "source": {
    "include": [
      "src/lib/functions/",
      "src/lib/Rekord.js",
      "src/lib/debug.js",
      "src/lib/rest.js",
      "src/lib/store.js",
      "src/lib/live.js",
      "src/lib/offline.js",
      "src/lib/batch.js",
      "src/lib/Gate.js",
      "src/lib/Database.js",
      "src/lib/Model.js",
      "src/lib/Map.js",
      "src/lib/Dependents.js",
      "src/lib/keys/KeyHandler.js",
      "src/lib/keys/KeySimple.js",
      "src/lib/keys/KeyComposite.js",
      "src/lib/collections/Collection.js",
      "src/lib/collections/Filtering.js",
      "src/lib/collections/Page.js",
      "src/lib/collections/FilteredCollection.js",
      "src/lib/collections/ModelCollection.js",
      "src/lib/collections/FilteredModelCollection.js",
      "src/lib/collections/RelationCollection.js",
      "src/lib/collections/DiscriminateCollection.js",
      "src/lib/search/Search.js",
      "src/lib/search/SearchPaged.js",
      "src/lib/Promise.js",
      "src/lib/operations/Operation.js",
      "src/lib/operations/GetLocal.js",
      "src/lib/operations/GetRemote.js",
      "src/lib/operations/RemoveCache.js",
      "src/lib/operations/RemoveLocal.js",
      "src/lib/operations/RemoveNow.js",
      "src/lib/operations/RemoveRemote.js",
      "src/lib/operations/SaveLocal.js",
      "src/lib/operations/SaveNow.js",
      "src/lib/operations/SaveRemote.js",
      "src/lib/relations/Relation.js",
      "src/lib/relations/RelationSingle.js",
      "src/lib/relations/RelationMultiple.js",
      "src/lib/relations/BelongsTo.js",
      "src/lib/relations/HasOne.js",
      "src/lib/relations/HasMany.js",
      "src/lib/relations/HasManyThrough.js",
      "src/lib/relations/HasRemote.js",
      "src/lib/relations/HasList.js",
      "src/lib/relations/Polymorphic.js",
      "src/lib/Shard.js",
      "src/lib/plugins/"
    ]
  },
  "templates": {
    "applicationName": "Rekord",
    "linenums": true,
    "cleverLinks": true,
    "default": {
      "outputSourceFiles": true
    }
  },
  "opts": {
    "destination": "../rekord-docs/docs/",
    "recurse": "true",
    "template": "./node_modules/jaguarjs-jsdoc",
    "readme": "./README.md",
    "pedantic": true,
    "debug": true
  },
  "plugins": [
    "plugins/markdown"
  ],
  "tags": {
    "allowUnknownTags": true
  }
}