dartdocでAPIドキュメントを作成する
Dartで書かれたプロジェクトであれば、 dartdoc でドキュメントが自動生成できます。
$ dartdoc
自分が作りたかった理由はPluginのscoreを上げたかったからなのですが、ローカルで試すに当たり、Dart自体の、Pluginには不要なドキュメントが生成されてしまいました。
なのでそれを除外するコマンドが次です。
$ dartdoc --exclude 'dart:async,dart:collection,dart:convert,dart:core,dart:developer,dart:io,dart:isolate,dart:math,dart:typed_data,dart:ui,dart:ffi,dart:html,dart:js,dart:js_util'
まだ泥臭い指定をしなければ一緒に生成されてしまうみたいです。
確認したバージョンは次のとおりです。
$ dartdoc --version dartdoc version: 0.29.1
今開発中のバージョンが 0.30.1まで出てますが、関連した修正は無さそうです。気軽に対象のディレクトリが指定できる形だと楽な気がしますね。
参考
dartdoc command should not generates docs for dart-sdk · Issue #1949 · dart-lang/dartdoc · GitHub
