coast-team/netflux

View on GitHub
esdoc.json

Summary

Maintainability
Test Coverage
{
  "source": "./docs/jsFromTs/src",
  "destination": "./docs",
  "includes": [".*Facade\\.js", ".*index\\.common\\.doc\\.js"],
  "plugins": [
    {
      "name": "esdoc-standard-plugin",
      "option": {
        "accessor": { "access": ["public", "protected", "private"], "autoPrivate": false },
        "undocumentIdentifier": { "enable": false },
        "unexportedIdentifier": { "enable": true },
        "typeInference": { "enable": false },
        "brand": {
          "logo": "./manual/asset/logo_favicon.jpg",
          "title": "Netflux",
          "description": "Abstract peer to peer client transport API. Implementations based on WebRTC and webSocket to be done.",
          "repository": "https://github.com/coast-team/netflux"
        },
        "manual": {
          "globalIndex": true,
          "asset": "./manual/asset",
          "files": [
            "./manual/installation.md",
            "./manual/usage.md",
            "./manual/knownobstacles.md",
            "./manual/faq.md"
          ]
        },
        "test": {
          "source": "./docs/jsFromTs/test/",
          "interfaces": ["describe", "it"],
          "includes": ["(spec|Spec|test|Test)\\.js$"]
        }
      }
    },
    {
      "name": "esdoc-inject-style-plugin",
      "option": {
        "enable": true,
        "styles": ["./manual/style.css"]
      }
    }
  ]
}