docs: update docs

Author: thetutlage

src/Router/Group.ts

@@ -85,7 +85,13 @@ export class RouteGroup<Context> extends Macroable implements RouteGroupContract
   }
 
   /**
-   * Define Regex matchers for a given param for all the routes
+   * Define Regex matchers for a given param for all the routes.
+   *
+   * @example
+   * ```ts
+   * Route.group(() => {
+   * }).where('id', /^[0-9]+/)
+   * ```
    */
   public where (param: string, matcher: RegExp | string): this {
     this.routes.forEach((route) => {
@@ -96,7 +102,13 @@ export class RouteGroup<Context> extends Macroable implements RouteGroupContract
   }
 
   /**
-   * Define prefix all the routes in the group
+   * Define prefix all the routes in the group.
+   *
+   * @example
+   * ```ts
+   * Route.group(() => {
+   * }).prefix('v1')
+   * ```
    */
   public prefix (prefix: string): this {
     this.routes.forEach((route) => {
@@ -107,7 +119,13 @@ export class RouteGroup<Context> extends Macroable implements RouteGroupContract
   }
 
   /**
-   * Define domain for all the routes
+   * Define domain for all the routes.
+   *
+   * @example
+   * ```ts
+   * Route.group(() => {
+   * }).domain(':name.adonisjs.com')
+   * ```
    */
   public domain (domain: string): this {
     this.routes.forEach((route) => {
@@ -118,7 +136,13 @@ export class RouteGroup<Context> extends Macroable implements RouteGroupContract
   }
 
   /**
-   * Prepend name to the routes name
+   * Prepend name to the routes name.
+   *
+   * @example
+   * ```ts
+   * Route.group(() => {
+   * }).as('version1')
+   * ```
    */
   public as (name: string): this {
     this.routes.forEach((route) => {
@@ -129,7 +153,13 @@ export class RouteGroup<Context> extends Macroable implements RouteGroupContract
   }
 
   /**
-   * Prepend an array of middleware to all routes middleware
+   * Prepend an array of middleware to all routes middleware.
+   *
+   * @example
+   * ```ts
+   * Route.group(() => {
+   * }).middleware(['auth'])
+   * ```
    */
   public middleware (middleware: any | any[]): this {
     this.routes.forEach((route) => {
@@ -140,7 +170,13 @@ export class RouteGroup<Context> extends Macroable implements RouteGroupContract
   }
 
   /**
-   * Define namespace for all the routes inside the group
+   * Define namespace for all the routes inside the group.
+   *
+   * @example
+   * ```ts
+   * Route.group(() => {
+   * }).namespace('App/Admin/Controllers')
+   * ```
    */
   public namespace (namespace: string): this {
     this.routes.forEach((route) => {

src/Router/Resource.ts

@@ -23,7 +23,7 @@ import { Route } from './Route'
  * Learn more http://weblog.jamisbuck.org/2007/2/5/nesting-resources.
  *
  * @example
- * ```js
+ * ```ts
  * const resource = new RouteResource('articles', 'ArticlesController')
  * ```
  */

src/Router/Route.ts

@@ -22,7 +22,7 @@ import { dropSlash } from '../helpers'
  * [[Router]] class helper methods.
  *
  * @example
- * ```js
+ * ```ts
  * const route = new Route('posts/:id', ['GET'], async function () {
  * })
  *

src/Router/Store.ts

@@ -30,7 +30,7 @@ import { exceptionCodes } from '../helpers'
  * for quick lookups.
  *
  * @example
- * ```js
+ * ```ts
  * const store = new Store()
  *
  * store.add({
@@ -85,7 +85,7 @@ export class Store<Context> {
    * matched against the URL to find the appropriate route.
    *
    * @example
-   * ```js
+   * ```ts
    * store.add({
    *   pattern: 'post/:id',
    *   methods: ['GET'],

src/Router/index.ts

@@ -33,8 +33,9 @@ import { toRoutesJSON, exceptionCodes, makeUrl } from '../helpers'
  * create route resources.
  *
  * @example
- * ```js
+ * ```ts
  * const router = new Router()
+ *
  * router.get('/', async function () {
  *   // handle request
  * })

src/Server/MiddlewareStore.ts

@@ -33,7 +33,7 @@ import { exceptionCodes } from '../helpers'
  * all middleware as plain functions and not `ioc namespaces`.
  *
  * @example
- * ```
+ * ```ts
  * const store = new MiddlewareStore()
  *
  * store.register([

src/helpers.ts

@@ -141,6 +141,5 @@ export const exceptionCodes = {
   E_ROUTE_NOT_FOUND: 'E_ROUTE_NOT_FOUND',
   E_INVALID_MIDDLEWARE_TYPE: 'E_INVALID_MIDDLEWARE_TYPE',
   E_MISSING_NAMED_MIDDLEWARE: 'E_MISSING_NAMED_MIDDLEWARE',
-  E_MISSING_CONTROLLER_METHOD: 'E_MISSING_CONTROLLER_METHOD',
   E_INVALID_ROUTE_NAMESPACE: 'E_INVALID_ROUTE_NAMESPACE',
 }

typedoc.js

@@ -1,7 +1,7 @@
 module.exports = require('@adonisjs/mrm-preset/_typedoc.js')({
   exclude: [
     '**/test/*.ts',
-    'src/contracts.ts',
+    'index.ts',
   ],
   readme: 'none',
 })