Improve docs

Author: eFrane

docs/.vuepress/jsdoc.js

@@ -48,8 +48,6 @@ function documentClasses (templateData) {
     return classNames
   }, [])
 
-  const classTemplate = loadTemplate('class')
-
   const classIndexData = {
     classes: {}
   }
@@ -61,22 +59,24 @@ function documentClasses (templateData) {
     }
   }
 
-  console.log(classIndexData)
-
+  const classTemplate = loadTemplate('class')
   classes.forEach(className => {
     const fileName = `docs/code/classes/${className}.md`
     const classData = templateData
       .filter(jsdocBlock => jsdocBlock.memberof === className)
       .sort((a, b) => {
         return a.order < b.order ? -1 : 1
-      }).forEach(classData => {
-        if (classData.kind === 'class') {
-          classIndexData.classes[className].description = classData.description
-        }
       })
 
+    classData.forEach(classData => {
+      if (classData.kind === 'class') {
+        classIndexData.classes[className].description = classData.description
+      }
+    })
+
     console.log(`rendering ${className} to ${fileName}`)
-    fs.writeFileSync(fileName, classTemplate({ className, classData }))
+    const context = { className, classData }
+    fs.writeFileSync(fileName, classTemplate(context))
   })
 
   console.log('rendering index for class documentation')

docs/.vuepress/templates/jsdoc/class.handlebars

@@ -9,4 +9,4 @@ activeHeaderLinks: true
 {{ jsDocBlock }}
 {{/each}}
 
-__This is an autogenerated class documentation for {{ className }} __
+_This is an autogenerated class documentation for {{ className }}_

docs/.vuepress/templates/jsdoc/kind.function.handlebars

@@ -0,0 +1,5 @@
+### {{ name }}()
+
+{{#if description}}
+{{ description }}
+{{/if}}

docs/code/classes/Builder.md

@@ -5,5 +5,38 @@ activeHeaderLinks: true
 ---
 # Class Builder
 
+JsonApi-based module builder for Vuex
 
-__This is an autogenerated class documentation for Builder __
+This module builder will create a vuex module based on the assumption of
+working with valid json api resources.
+
+- the proposed json api 1.1 pagination style meta attributes
+  (-> https://jsonapi.org/format/1.1/#fetching-pagination)
+
+## Builder()
+
+Module Builder for Json:Api bound Vuex Modules
+
+### build()
+
+Build the module for this builder instance
+
+### buildMutations()
+
+Build the mutations
+
+### build()
+
+Returns a new functional resource object
+
+Functional resource objects are structurally identical to
+normal JSON:API resource objects but are enhanced with
+methods to simplify access to relationships.
+
+### strip()
+
+Convenience method to get a spec-conforming version of
+a resource object
+
+
+_This is an autogenerated class documentation for Builder_

docs/code/classes/FosJsRoutingRouter.md

@@ -5,5 +5,7 @@ activeHeaderLinks: true
 ---
 # Class FosJsRoutingRouter
 
+Pluggable api router if you're using Symfony and the FosJsRouting Bundle
 
-__This is an autogenerated class documentation for FosJsRoutingRouter __
+
+_This is an autogenerated class documentation for FosJsRoutingRouter_

docs/code/classes/JsonApiRouter.md

@@ -5,5 +5,44 @@ activeHeaderLinks: true
 ---
 # Class JsonApiRouter
 
+A simple router implementation querying a json:api endpoint which delivers all
+necessary route information
 
-__This is an autogenerated class documentation for JsonApiRouter __
+The endpoint must return a list of Route objects:
+
+```json
+{
+    "data": [
+        {
+            "type": "Route",
+            "id": "api.route.list",
+            "attributes": {
+                "parameters": [],
+                "url": "api/route",
+                "method": "list"
+            }
+       },
+       {
+           "type": "Route",
+           "id": "api.route.get",
+           "attributes": {
+               "parameters": [
+                   "id"
+               ],
+               "url": "api/route/{id}",
+               "method": "get"
+           }
+       }
+    ]
+}
+```
+
+To initialize this router, simply `new` it with the desired fetch path,
+e.g. `new JsonApiRouter('/api/route')`.
+
+### updateRoutes()
+
+Update routes
+
+
+_This is an autogenerated class documentation for JsonApiRouter_

docs/code/classes/Route.md

@@ -6,4 +6,14 @@ activeHeaderLinks: true
 # Class Route
 
 
-__This is an autogenerated class documentation for Route __
+
+### prepare()
+
+Prepare an url, replacing provided parameters
+
+### hasParameter()
+
+Check if a parameter is allowed
+
+
+_This is an autogenerated class documentation for Route_

docs/code/classes/Router.md

@@ -5,5 +5,23 @@ activeHeaderLinks: true
 ---
 # Class Router
 
+Basic router implementation for the ResourcefulApi.
 
-__This is an autogenerated class documentation for Router __
+Automagically creating api bound modules builds on
+an understanding of the available routes. To
+easily instantiate a Store bound to an endpoint,
+route information for that endpoint must be provided.
+
+Since every endpoint is implemented differently and
+the choice where this route information comes from
+should be left to the endpoint developer, this
+library only assumes that route loading is usually an
+asynchronous process which eventually returns and
+has a set of keyed-by-name `Route` objects in
+`this.routes`.
+
+### addRoute()
+
+
+
+_This is an autogenerated class documentation for Router_

docs/code/classes/StaticRouter.md

@@ -5,5 +5,17 @@ activeHeaderLinks: true
 ---
 # Class StaticRouter
 
+Static router
 
-__This is an autogenerated class documentation for StaticRouter __
+It may be desirable to not do an additional request
+for getting the api routes and instead bake them into
+the code. To this avail, the `StaticRouter` can be
+initialized with a POJO of { id, url, parameters }
+whereas parameters are parts of the url which can be replaced.
+
+## StaticRouter()
+
+
+
+
+_This is an autogenerated class documentation for StaticRouter_