autogsdoc - クラウド上のオンライン

プログラム：

NAME

autogsdoc - GNUstep API ドキュメント ジェネレーターおよび XML->HTML コンバーター

SYNOPSIS

autogsdoc [-ファイル ファイル名] [-HTMLの生成 はい|いいえ] [-綺麗 はい|いいえ] [-クリーンテンプレート
はい|いいえ] [-依存関係を無視 はい|いいえ] [-MakeDependency はい|いいえ] [-ShowDependency はい|いいえ]
[-ヘッダーディレクトリ path] [-ドキュメントディレクトリ path] [-宣言済み 場所] [-事業
タイトル] [-規格 はい|いいえ] [-DocumentAllInstanceVariables はい|いいえ]
[-DocumentInstanceVariables はい|いいえ] [-InstanceVariablesAtEnd はい|いいえ] [-定数テンプレート
ファイル名] [-関数テンプレート ファイル名] [-マクロテンプレート ファイル名] [-TypedefsTemplate
ファイル名] [-変数テンプレート ファイル名] [-システムプロジェクト string] [-ローカルプロジェクト string]
[-プロジェクト 辞書文字列] [-詳細 はい|いいえ] [-警告 はい|いいえ] [-ワードマップ 辞書文字列] [ファイル]

DESCRIPTION

autogsdoc ツールは、開発者がリファレンスを作成するのに役立つコマンドライン ユーティリティです。
GNUstep API のドキュメント。 また、開発者が他の機能を作成および保守できるようになります。
XML でドキュメントを作成し、それを HTML に変換します。 詳細には、autogsdoc は次のことを行います。

- クラス、カテゴリ、
Objective C ソース コード (ヘッダー ファイルと
オプションでソース ファイル) を GSDoc XML ファイルに変換します。

- ソース コードから生成されたか、手動で記述された GSDoc XML ファイルを変換します。
開発者は HTML に変換できます。

- GSDoc XML ファイルセットに基づいてインデックスを構築し、それらを HTML にも変換します。

最も一般的な使用法は、XNUMX つ以上のヘッダー ファイル名を指定してコマンドを実行することです。
引数 ... ツールは同じファイル内の対応するソース ファイルを自動的に解析します。
ヘッダーとしてディレクトリ (または現在のディレクトリ、または
DocumentationDirectory のデフォルト）、出力として GSDoc および HTML ファイルを生成します。 最善のために
結果として、このモードはソース ファイルを含むディレクトリから実行する必要があります。 （ノート
C は Objective C のサブセットであるため、このツールは機能を文書化するために動作し、
プレーン C ソース内の他の C 構造体。)

GSDoc ファイルは、直接追加または単独で指定することもでき、変換されます。
HTMLに。 GSDoc HTML ドキュメントまたは gsdoc(7) に関する情報のマニュアルページ
GSDoc 形式。

最後に、HTML ファイルをコマンド ラインで指定できます。 の他の部分への相互参照
その中にあるコードドキュメントは、その中にある内容に基づいて書き換えられます。
現在のプロジェクト。

SOURCE CODE マークアップ

ソース コード パーサーは、メソッドをリストした GSDoc ドキュメントを自動的に生成します。
ソース ファイル内で見つかったクラス。特別にフォーマットされたテキストが含まれます。
ソースファイルからのコメント。

スラッシュとで始まるコメント 2 一般的なスラッシュやシングルではなくアスタリスク
アスタリスクは GSDoc マークアップとみなされ、クラスまたはメソッドの説明として使用されます。
それに続いて。 このコメント テキストは再フォーマットされて出力に挿入されます。
複数のコメントが同じアイテムに関連付けられている場合、それらは
改行( ) 必要に応じて、それぞれの間に。

このツールは、単にプログラムやライブラリを文書化するために簡単に使用できます。
プログラムの main() 関数を含むソース ファイルの名前 - これは
その関数からの特別なコメントを取得し、それらを特別に処理して、
ドキュメントの最初の章の終わりにあるセクション (次の場合に最初の章が作成されます)
必要）。

オプション セクションで説明されています Arguments と デフォルト を参照してください。

EXTRA マークアップ

特別な追加処理が実行される場合がいくつかありますが、主に
ソース ファイル内で見つかった最初のコメント。そこから GSDoc マークアップのさまざまなチャンクが抽出される可能性があります。
抽出され、出力ドキュメント内の適切な場所に配置されます -

Autogsdocソース:
どの行でも Autogsdocソース: が見つかると、行の残りの部分が
各 .h ファイルを仮定する代わりに使用されるソース ファイル名
処理では、同じ名前の .m ファイルが使用されます。 複数指定することもできます Autogsdocソース:
ヘッダー ファイルで複数のソース ファイルで定義されている項目を宣言する行。
ファイル名が絶対名の場合は、指定されたとおりに使用されます。 一方、それが
相対パスの場合、ソフトウェアは最初にその場所を基準にしてソース ファイルを検索します。
ヘッダー ファイルの、そこに見つからない場合は、現在のディレクトリを基準とした相対パス。
autogsdoc が実行中であり、最終的には、
ドキュメンテーション ディレクトリ デフォルト。


ドキュメントの内容の要約 ... GSDoc 出力の先頭に配置されます。


コードの作成者の説明 - 場合に対処するために繰り返される場合があります。
文書には複数の作成者がいます。 GSDoc 出力の先頭に配置されます。 補助として
ソースの可読性を考慮して、関連するいくつかの特別な追加処理が実行されます。
ドキュメントの作成者 - 「作成者: 名前」という形式の任意の行'、または '次の方法で:
名前'、'作成者: 名前'、または '作成者: 名前' が認識され、
に変換 著者 要素、おそらくは email 要素。


GSDoc 出力内のドキュメント本文の終わりの直前に配置 - 意図されています
付録、索引などに使用されます。


生成されたクラスドキュメントの直前に配置されます...使用されることを目的としています
文書化されているコードがどのように動作するかについての全体的な説明を提供します。 どれでも
プログラムの main() 関数のドキュメントは最後にセクションとして挿入されます
この章の。


ドキュメントのコンテンツの著作権 ... GSDoc 出力の先頭に配置されます。
ソースを読みやすくするために、いくつかの特別な追加処理が行われます。
実行 - 「Copyright (C) text」形式の行は認識され、変換されます。
へ copy 要素。


ドキュメントの改訂日 ... GSDoc 出力の先頭に配置されます。 もしも
これを省略すると、ツールは RCS Date タグから値を構築しようとします (
利用可能）。


文書の本文の先頭に挿入されます ... を提供することを目的としています
紹介ページや目次ページなど。


ドキュメントのタイトル ... GSDoc 出力の先頭に配置されます。 これを省略した場合
このツールは独自の（おそらく貧弱な）タイトルを生成するため、これを含める必要があります
手動でマークアップします。


ドキュメントのバージョン識別子 ... GSDoc 出力の先頭に配置されます。 もしも
これを省略すると、ツールは RCS リビジョン タグから値を構築しようとします (
利用可能）。

NB ここで説明したマークアップは、クラス、カテゴリ、またはプロトコルのドキュメント内で使用できます。
...そうであれば、それが抽出され、クラスの残りのドキュメントにラップされます。
クラスの章として。 残りのクラスドキュメントは通常、次の場所に挿入されます。
章の終わりですが、代わりに擬似-
内の要素エレメント。

METHOD マークアップ

メソッド説明のテキストを提供するために使用されるコメントでは、次のマークアップが使用されます。
テキストから削除され、特別に処理されます -


メソッドは、クラスの指定された初期化子としてマークされます。


このメソッドは、サブクラスがオーバーライドする必要があるメソッドとしてマークされています (抽象メソッドなど)。
方法）。


このメソッドは、サブクラスが実行すべきメソッドとしてマークされています。 NOT オーバーライド。


マークアップは説明から削除され、配置されます。 After それはGSDoc出力に含まれます -
そのメソッドが指定された規格に準拠している (または準拠していない) と記述されるようにする
標準。

自動化された マークアップ

通常、コメント内のテキストは標準化され、適切にインデントされるように再フォーマットされます。
再フォーマットは 内の任意のテキストに対して実行されます。 エレメント。 テキストが
再フォーマットされると、空白で区切られた「単語」に分割され、その後、
追加の処理がいくつかあります...

YES、NO、nil などのよく知られた定数は...で囲まれています。
マークアップ。

メソッド説明内のメソッド引数の名前は...で囲まれます。
</ var> マークアップ。

メソッド名（プラスまたはマイナスで始まる）は「」で囲まれます。 ...
マークアップ。 たとえば、「-init」(引用符なし) は GSDoc 参照でラップされます。
現在のクラスの init メソッドを指す要素、または既知のクラスが XNUMX つだけの場合は
init メソッドがあった場合、そのクラスのメソッドを参照します。 という事実に注意してください
メソッド名を認識するには、メソッド名を空白で囲む必要があります (カンマは使用しますが、
指定子の末尾のフルストップまたはセミコロンは空白のように機能します)。

クラス名を含むメソッド指定子 (角括弧で始まり、角括弧で終わる)
に囲まれています... マークアップ。 例: '[NSObject-init]' は、
NSObject の init メソッドへの参照 (適切なクラス、またはそのクラスのいずれか)
カテゴリ)、'[(NSCopying)-copyWithZone:]' では、メソッドへの参照が作成されます。
NSCopying プロトコル。 角括弧の間にスペースを入れてはいけないことに注意してください
これらの指定子で。 プロトコル名は、
GSDoc は XML 言語であり、XML は角度を扱うため、慣習的な山かっこ
特別にブラケット。

「main()」以外の関数名（末尾が「()」）は「」で囲みます。 ...
マークアップ。 たとえば、「NSLogv()」（引用符なし）は GSDoc でラップされます。
NSLog 関数のドキュメントを指す参照要素。 事実に注意してください
関数名は空白 (カンマ、フルストップ、または
指定子の末尾のセミコロンは空白終端文字としても機能します)。

議論 そして デフォルト

このツールは特定のユーザー デフォルトを受け入れます (もちろんコマンドラインとして指定できます)
引数は、次のようにデフォルト名の前に「-」を追加し、その後に値を指定します。
-クリーンはい):

石斑魚
このブール値が YES に設定されている場合、ドキュメントを生成するのではなく、
このツールは、プロジェクトで生成されたすべての GSDoc ファイルと生成されたすべての HTML ファイルを削除します
それらから (およびリストされている GSDoc ファイルから生成されるものすべて)
明示的に)、最後にプロジェクト インデックス ファイルを削除します。 これの唯一の例外は
そのテンプレート GSDoc ファイル (つまり、「-ConstantsTemplate ...」を使用して指定されたファイル)
"-FunctionsTemplate ..." 引数など) は、CleanTemplates が削除されない限り削除されません。
フラグが設定されます。

きれいなテンプレート
このフラグは、テンプレート GSDoc ファイルを他のファイルと一緒に削除するかどうかを指定します。
Clean オプションが指定されている場合、ファイルが削除されます。 デフォルトでは削除されません
...これらのテンプレートは手動で作成され、データが挿入されただけである可能性があるため
それらに。

定数テンプレート
定数に関するドキュメントが含まれるテンプレートドキュメントの名前を指定します。
プロジェクト内のすべてのファイルから挿入する必要があります。 これは、定数が
ソースコードが多くのファイルに散在しているため、それらを XNUMX つにグループ化する必要がある
場所。 基本的なテンプレート ドキュメント (
個別の定数ドキュメントが挿入されます) には、必要なその他すべての情報が含まれます。
必要ですが、便宜上、autogsdoc は単純なテンプレートを生成します (これは、
ファイルが存在しない場合は、編集してください)。 挿入はすぐに行われます
前 バック 要素 (または、それが存在しない場合は、要素の終わりの直前)
ボディ 要素）をテンプレートに含めます。

宣言された
ヘッダーが見つかったことを文書化する場所を指定します。 実際に生まれた名前
ドキュメント内の は、ヘッダー ファイル名の最後のコンポーネントを追加することによって形成されます
このデフォルトの値に設定します。 このデフォルトが指定されていない場合、
ヘッダー ファイル (コマンド ラインで指定)、デフォルトの HeaderDirectory を使用
先頭に付けて使用されます。 これの典型的な使用法は、次のような場合に「-Declared Foundation」となります。
GNUstep ベース ライブラリのドキュメントを生成します。 この結果、
ドキュメントには、NSString が「Foundation/NSString.h」で宣言されていることが記載されています

ドキュメントすべてのインスタンス変数
このフラグを使用すると、すべてのインスタンス変数のドキュメントを生成できます。 通常は、
明示的に「公開」または「保護」と宣言されたもののみが文書化されます。

ドキュメントインスタンス変数
このフラグを使用すると、インスタンス変数のドキュメントを完全にオフにすることができます。
通常、明示的に宣言された「パブリック」または「プロテクト」インスタンス変数は、
文書化されています。

インスタンス変数AtEnd
このフラグが設定されている場合、HTML ジェネレーターにインスタンス変数のドキュメントを配置するよう指示します。
クラスの始めではなく、終わりに。 たくさん使う場合に便利です
二次的にのみ使用される保護されたインスタンス変数
クラスの一般ユーザー。

ドキュメンテーション ディレクトリ
生成されたドキュメントを配置するディレクトリを指定するために使用できます。
これが設定されていない場合、出力は現在のディレクトリに配置されます。 このディレクトリも
ソース ファイル (ヘッダーではない) を見つけるための最後の手段として使用されますが、さらに重要なことに、
として使用されます 最初の と の に渡された .gsdoc ファイルを見つけます。
コマンドライン。 これらのファイルに指定されたパス情報はすべて、 削除 そして彼らは
「DocumentationDirectory」で検索されました (検索されなかった場合でも)
自動生成されます）。


ファイル名のリストを含むファイルの名前をプロパティ リスト配列として指定します。
(名前1、名前2、...) フォーマット。 これが存在する場合、プログラム引数リスト内のファイル名
は無視され、このファイル内の名前が処理する名前のリストとして使用されます。

関数テンプレート
関数に関するドキュメントが含まれるテンプレートドキュメントの名前を指定します
プロジェクト内のすべてのファイルから挿入する必要があります。 これは関数ソースの場合に便利です
コードは多くのファイルに散在しているため、コードを XNUMX か所にグループ化する必要があります。 あなたは
基本的なテンプレート文書（個人の
関数のドキュメントが挿入されます) には必要なその他の情報がすべて含まれていますが、
便宜上、autogsdoc は単純なテンプレートを生成します (後で編集できます)。
ファイルが存在しない場合は、 挿入は直前に行われます。 バック
要素 (または、それが存在しない場合は、要素の終わりの直前) ボディ 要素）で
テンプレート。

HTMLの生成
HTML 出力を生成するかどうかを指定するために使用できます。 デフォルトはYESです。

ヘッダー ディレクトリ
ヘッダー ファイルを検索するディレクトリを指定するために使用できます。 供給されると、
この値は相対ヘッダー名の前に付加されます。それ以外の場合は、相対ヘッダー名が付加されます。
現在のディレクトリを基準にして解釈されます。 絶対として指定されたヘッダー ファイル
パスはこのデフォルトの影響を受けません。

依存関係を無視
プログラムがファイルを無視することを指定するために使用できるブール値。
とにかく変更回数を減らしてファイルを再生成します。 と組み合わせて使用​​するために提供されます
「make」システムは、依存関係のチェック自体を管理することが期待されています。

ローカルプロジェクト
この値は、ローカル外部プロジェクトの自動組み込みを制御するために使用されます。
最終的なドキュメント出力で相互参照を生成するためのインデックス システム。 もしも
「なし」に設定すると、ローカル プロジェクトの参照は行われません。それ以外の場合は、「ローカル」
GNUstep ドキュメント ディレクトリで、「.igsdoc」を持つファイルが再帰的に検索されます。
拡張子が付けられており、それらのファイルのインデックス情報が使用されます。 この価値は
文字列は、相互参照内のファイル名を生成するためにも使用されます...
空の文字列の場合、使用するパスは、
igsdoc ファイルが見つかりました。それ以外の場合は、インデックス内の名前のプレフィックスとして使用されます。 注意。
現在文書化されているプロジェクトと同じ名前のローカル プロジェクトは、
このメカニズムに組み込まれます。 そのようなプロジェクトを含めたい場合は、そうする必要があります
明示的に使用する -プロジェクト ...

マクロテンプレート
マクロに関するドキュメントを含めるテンプレート ドキュメントの名前を指定します
プロジェクト内のすべてのファイルから挿入されます。 マクロコードが分散している場合に便利です。
多くのファイルがある場合は、それを XNUMX か所にグループ化する必要があります。 あなたには責任があります
基本的なテンプレート ドキュメント (個々のマクロ ドキュメントが組み込まれる) が確実に作成されるようにする
が挿入されています) 必要なその他の情報がすべて含まれていますが、便宜上
autogsdoc は、次の場合に簡単なテンプレートを生成します (後で編集できます)。
ファイルが存在しません。 挿入は直前に行われます。 バック 要素 (または
存在しない、終了直前 ボディ
要素）をテンプレートに含めます。

MakeDependency
make の依存関係情報を出力するために使用されるファイル名。 これには、
プロジェクトの依存関係として認識されているすべてのヘッダー ファイルとソース ファイルをリストする形式。
プロジェクト名 (「プロジェクト」を参照)。

プロジェクト
このプロジェクトの名前を指定するために使用できます...インデックスの名前を決定します
ドキュメントの一部として作成され、有効にする情報を提供する参照ファイル
このプロジェクト内の項目を相互参照する他のプロジェクト。

公共計画
この値は、igsdoc へのパスを含む辞書として指定できます。
外部プロジェクトで使用されるインデックス/参照ファイルと、マッピングに使用される値
インデックスで見つかったファイル名。 たとえば、プロジェクト インデックス (igsdoc) ファイルの場合、
クラス「Foo」がファイル「Foo」内に見つかり、パスが関連付けられていることがわかります。
そのプロジェクト インデックスは「/usr/share/doc/proj」です。生成された HTML 出力は参照する可能性があります。
クラスは '/usr/share/doc/prj/Foo.html' にあります。 辞書は次のような場合があることに注意してください。
標準の PropertyList 形式 (XML ではない) を使用してコマンド ラインで指定します。
OS X の形式)、行区切り文字としてセミコロンを使用し、単一の文字列で囲みます。
引用。

依存関係を表示
プログラムがどのファイルをログに記録するかを指定するために使用できるブール値。
他のファイルに依存しているため、再生成されています。

規格
プログラムが次の情報を挿入するかどうかを指定するために使用されるブール値。
標準への準拠をドキュメントに組み込みます。 これは次の場合にのみ使用してください。
コードが次のように想定されているため、GNUstep ライブラリとツール自体を文書化します。
文書化されているものは GNUstep の一部であり、OpenStep 標準に準拠している可能性があります。
または MacOS-X 互換メソッドを実装します。

システムプロジェクト
この値は、システム外部プロジェクトの自動組み込みを制御するために使用されます。
最終的なドキュメント出力で相互参照を生成するためのインデックス システム。 もしも
「なし」に設定すると、システム プロジェクトの参照は行われません。それ以外の場合は、「システム」
GNUstep ドキュメント ディレクトリで、「.igsdoc」を持つファイルが再帰的に検索されます。
拡張子が付けられており、それらのファイルのインデックス情報が使用されます。 この価値は
文字列は、相互参照内のファイル名を生成するためにも使用されます...
空の文字列の場合、使用するパスは、
igsdoc ファイルが見つかりました。それ以外の場合は、インデックス内の名前のプレフィックスとして使用されます。 注意。
現在文書化されているプロジェクトと同じ名前のシステム プロジェクトは、
このメカニズムに組み込まれます。 そのようなプロジェクトを含めたい場合は、そうする必要があります
明示的に使用する -プロジェクト ...

TypedefsTemplate
typedef に関するドキュメントを含めるテンプレート ドキュメントの名前を指定します
プロジェクト内のすべてのファイルから挿入されます。 これは、typedef ソース コードが
多くのファイルが散在しているため、それを XNUMX か所にグループ化する必要があります。 あなたは
基本的なテンプレート文書（個人の
typedef ドキュメントが挿入されます) には必要な他の情報がすべて含まれていますが、
便利な autogsdoc は、簡単なテンプレートを生成します (後で編集できます)。
ファイルが存在しない場合は、 挿入は直前に行われます。 バック
要素 (または、それが存在しない場合は、要素の終わりの直前) ボディ 要素）で
テンプレート。

Up 生成された GSDoc からの「アップ」リンクで使用される名前を指定するために使用される文字列
書類。 これは通常、インデックスを含むファイルの名前でなければなりません。
プロジェクトの内容。 これが欠落しているか、空の文字列に設定されている場合、「up」は行われません。
リンクはドキュメント内に提供されます。

変数テンプレート
変数に関するドキュメントが含まれるテンプレートドキュメントの名前を指定します。
プロジェクト内のすべてのファイルから挿入する必要があります。 これは変数ソースの場合に便利です
コードは多くのファイルに散在しているため、コードを XNUMX か所にグループ化する必要があります。 あなたは
基本的なテンプレート文書（個人の
変数ドキュメントが挿入されます) には必要なその他の情報がすべて含まれていますが、
便宜上、autogsdoc は単純なテンプレートを生成します (後で編集できます)。
ファイルが存在しない場合は、 挿入は直前に行われます。 バック
要素 (または、それが存在しない場合は、要素の終わりの直前) ボディ 要素）で
テンプレート。

冗長
詳細なデバッグ/警告出力を行うかどうかを指定するために使用されるブール値。
生産。

警告する
標準の警告出力が必要かどうかを指定するために使用されるブール値 (例:
文書化されていない方法) で生成されます。

ワードマップ
この値は、ソース ファイル内で見つかった識別子/キーワードをマップするために使用される辞書です。
他の言葉に。 通常、これを使用する必要はありませんが、役立つ場合もあります
C プリプロセッサ マクロの使用によってパーサーが混乱するのを避けるため。 あなたはできる
マクロをより混乱の少ないものに効果的に再定義します。 マップする値
識別子は次のいずれかでなければなりません - 別の識別子、空の文字列 - 値は
無視されます。XNUMX つのスラッシュ ('//') - 行の残りの部分は無視されます。 辞書に注意してください
標準の PropertyList 形式 (
OS X の XML 形式）、行区切り文字としてセミコロンを使用し、単一で囲みます。
引用。

文書間 リンケージ

'Up' デフォルトは、ドキュメントの名前を指定するために使用されます。
使用されているその他のドキュメントについては、「アップ」リンクを使用してください。 この名前にはパスや拡張子を含めることはできません。
通常、このデフォルトで参照されるドキュメントは手動で編集された GSDoc ドキュメントである必要があります。
これには、プロジェクトのインデックスを含む後部セクションが必要です。 例えば


<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.3//EN"
"http://www.gnustep.org/gsdoc-1_0_3.xml">


私のプロジェクトのリファレンス




私のプロジェクトのリファレンス

onworks.net サービスを使用してオンラインで autogsdoc を使用する