How it works...

We are using TypeDoc, which is a documentation generator for a TypeScript application. It uses TSDoc comments, which are very similar to the popular JSDoc. All of the magic work is done in gulpfile.js.

First, we have a typedoc task. Basically, it takes all TypeScript src files using gulp.src(["src/**/*.ts"]) and pipe it to typedoc. Then, typedoc generates the documentation based on the class's structure and TSDoc comments in the file. You can learn about the configuration about TypeDoc from their website at http://typedoc.org. Basically, here we are configuring site title, the location of docs, and the bunch of other things.

If you take a look inside home.ts, we have dummyFunction, which looks as follows:

 /** * Following ...

Get Ionic Cookbook - Third Edition now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.