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

AutoIndex Toolが採択された

C++

AutoIndex review result


Boostのドキュメントで自動で索引を生成するAutoIndexツールが採択されました。
以下レビュー結果です。


==


AutoIndexのレビューは満場一致で賛成だったため、これはBoostに採択することが決定した。


レビューは以下のメンバによって提出された:Paul A. Bristow, Barend Gehrels and Hartmut Kaiser。Artyomも参加した。


提起された問題点をいくつか:

  • 名前は一貫性があるべきだ。
  • インストールに少し混乱した。これはBoostの一部にするならより簡単にする必要がある。
  • これはdockbookレベルで動作するので、純粋なquickbookユーザーは少し混乱する。我々はテンプレートライブラリの形式でquickbookのサポートを追加する必要がある。
  • 別のドキュメント作成ツールの統合に関するいくつかの混乱があった。例えばオプションとして'xinclude'をquickbookにdoxygenドキュメンテーションを含めるために使用し、オプションとしてquickbookに内容を含めるためにを使用する。私はこれがむしろquickbookドキュメンテーションの弱点だと考える。
  • 何人かのレビュアーは、インデックス用語の挿入場所をより細かく制御することを望んだ。それが多くの複雑さを加えることなく実現できるかどうかはわからない。xmlへ処理命令を加えることもひとつの可能性だ。
  • C++のヘッダスキャンは、Spiritであまりに多くのシンボルを拾ってくる(そしておそらく他のライブラリも同じ)。


レビューの参加した方々、そしてAutoIndex開発者のJohn Maddockに感謝する。