Skip to Content
Ionic Cookbook - Third Edition
book

Ionic Cookbook - Third Edition

by Indermohan Singh
April 2018
Intermediate to advanced content levelIntermediate to advanced
390 pages
8h 46m
English
Packt Publishing
Content preview from Ionic Cookbook - Third Edition

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 ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Start your free trial

You might also like

Learning Ionic - Second Edition

Learning Ionic - Second Edition

Arvind Ravulavaru
Ionic in Action

Ionic in Action

Jeremy Wilken
Ionic : Hybrid Mobile App Development

Ionic : Hybrid Mobile App Development

Rahat Khanna, Sani Yusuf, Hoc Phan
ReasonML Quick Start Guide

ReasonML Quick Start Guide

Raphael Rafatpanah, Bruno Joseph D'mello

Publisher Resources

ISBN: 9781788623230Supplemental Content