読者です 読者をやめる 読者になる 読者になる

しゅみぷろ

プログラミングとか

UnityTexturePaintのドキュメント公開

はじめに

Asset Storeでの公開を夢見て、とりあえずドキュメント作らなきゃということでドキュメントを公開しました。

しゅみぷろ(このブログ)のサイドバーのリンクからUnityTexturePaintDocumentを辿ってもらえれば見れます。

Unity Texture Paint: Main Page

Doxygenにほぼデフォ設定でぶっこんだだけで見栄えがアレなので、余裕ができてきたらカスタマイズしていこうと思います。

このページのサムネとかドキュメントのイメージとかは@traitam様に作成して頂きました。本当に忙しい中ありがとうございます・・・。

Document生成

報告だけじゃ寂しいのでDocument生成についてもちょっとメモしておきます。

使用しているツールはDoxygen。お世話になってます。

f:id:es_program:20161119194829p:plain:w600

Doxygenは名前通りドキュメント生成ツールですが、GUIで設定ファイルが弄れるようになっていて、導入がものすごく楽です。

上記の画像のような感じで、プロジェクト名や概要、バージョンなど、必要な項目を埋めていきます。

f:id:es_program:20161119195441p:plain:w600

今回のドキュメントの運用では、GitHub Pagesを利用するため出力するドキュメント形式はHTMLのみ、出力ディレクトリでhtmlフォルダを生成しないよう設定を追加しました。

埋め終わったらRun doxygenボタンを押せば、ドキュメントを吐き出してくれます。