O'Reilly logo

Dart: Scalable Application Development by Ivo Balbaert, Sergey Akopkokhyants, Davy Mitchell

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Documenting your app

A project needs to be documented so that future developers can change and expand it. From release 1.2 onwards, the docgen tool is provided as an API Documentation Generator, which generates and serves documentation for the Dart SDK and packages, as well as for your applications. This recipe is designed to show you how to best document the application you have built.

Getting ready

Run pub get on your project before running the docgen tool. We will illustrate this with the bank_terminal_polymer app.

How to do it...

  1. In a command-line session at the top level of your app, run:
    docgen .
    
  2. When the documentation is generated, issue the following command:
    docgen --serve .
    

    This installs the dartdoc-viewer tool and starts up a local web ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required