autogsdoc - クラウドでオンライン

プログラム：

NAME

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

SYNOPSIS

autogsdoc [-ファイル ファイル名] [-HTML を生成する はい|いいえ] [-綺麗 はい|いいえ] [-クリーンテンプレート
はい|いいえ] [-依存関係を無視 はい|いいえ] [-依存関係を作成する はい|いいえ] [-依存関係を表示 はい|いいえ]
[-ヘッダーディレクトリ path] [-ドキュメントディレクトリ path] [-宣言した 場所] [-事業
タイトル] [-標準 はい|いいえ] [-すべてのインスタンス変数を文書化 はい|いいえ]
[-ドキュメントインスタンス変数 はい|いいえ] [-インスタンス変数終了時 はい|いいえ] [-定数テンプレート
ファイル名] [-関数テンプレート ファイル名] [-マクロテンプレート ファイル名] [-Typedefsテンプレート
ファイル名] [-変数テンプレート ファイル名] [-システムプロジェクト string] [-ローカルプロジェクト string]
[-プロジェクト 辞書文字列] [-詳細 はい|いいえ] [-警告 はい|いいえ] [-ワードマップ 辞書文字列] [ファイル]

DESCRIPTION

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

- クラス、カテゴリ、のパブリックインターフェースを説明する特別なコメントを抽出します。
Objective Cソースコード（ヘッダーファイルと
オプションでソースファイルを GSDoc XML ファイルに変換します。

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

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

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

GSDocファイルは、追加または単独で直接指定することもでき、変換されます。
HTMLに。GSDoc HTMLドキュメントまたは グスドク（7）マニュアルページ
GSDoc 形式。

最後に、HTMLファイルをコマンドラインで指定することもできます。
その中にあるコードドキュメントは、
現在プロジェクト中。

SOURCE CODE マークアップ

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

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

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

オプション セクションに記載されています Arguments 　 デフォルト を参照してください。

EXTRA マークアップ

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

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


ドキュメントの内容の要約...GSDoc 出力のヘッダーに配置されます。


コードの作成者の説明 - 次のようなケースに対応するために繰り返される場合があります。
文書に複数の著者がいる。GSDoc出力の先頭に配置される。
ソースの可読性を高めるために、いくつかの特別な追加処理が実行される。
文書の作成者 - 'Author: name' 形式の行'、または 'By:
名前'、'著者: 名前'、'By: 名前'が認識され、
に変換された 著者 要素、おそらく メール 要素。


GSDoc出力の文書本文の最後の直前に配置されます。
付録、索引などに使用します。


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


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


文書の改訂日...GSDoc出力の先頭に配置されます。
これが省略されると、ツールはRCS日付タグから値を構築しようとします（
利用可能）。


本文の冒頭に挿入された...提供することを意図した
紹介ページや目次ページなど


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


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

NB ここで説明したマークアップは、クラス、カテゴリ、またはプロトコルのドキュメント内で使用できます。
...もしそうなら、それは抽出され、クラスの残りのドキュメントにラップされます
クラスの章として挿入されます。クラスのドキュメントの残りの部分は通常、
章末に代えて、擬似-
要素内の要素。

METHOD マークアップ

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


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


メソッドはサブクラスがオーバーライドする必要があるものとしてマークされています（例：抽象
方法）。


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


マークアップは説明から削除され、 After GSDoc出力でそれを -
方法は、指定されたものに準拠している（または準拠していない）と説明される。
標準。

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

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

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

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

メソッド名（プラスまたはマイナスで始まる）は、 ...
マークアップ。例えば、「-init」（引用符なし）はGSDoc参照で囲まれます。
現在のクラスのinitメソッドを指す要素、または既知のクラスが1つしかない場合は
initメソッドがあった場合、そのクラスのメソッドを参照します。
メソッド名が認識されるためには空白で囲まれている必要があります（ただし、カンマ、
指定子の末尾のピリオドまたはセミコロンは空白文字のように動作します)。

クラス名を含むメソッド指定子（角括弧で始まり角括弧で終わる）
囲まれている...マークアップ。例えば「[NSObject-init]」は、
NSObjectのinitメソッドへの参照（クラス自体、またはその
カテゴリ）に対して、「[(NSCopying)-copyWithZone:]」は、
NSCopyingプロトコル。角括弧の間にスペースを入れてはいけないことに注意してください。
これらの指定子では、プロトコル名は丸括弧で囲まれます。
GSDocはXML言語であり、XMLは角括弧を
括弧は特に必要です。

'main()'以外の関数名（'()'で終わる）は、 ...
マークアップ。例えば「NSLogv()」（引用符なし）はGSDocで囲まれます。
NSLog関数のドキュメントを指す参照要素。
関数名は空白で囲む必要があります（ただし、カンマ、ピリオド、または
指定子の末尾のセミコロンは空白の終端としても機能します。

議論 そして デフォルト

このツールは、特定のユーザーデフォルト（もちろんコマンドラインで指定可能）を受け入れます。
引数は、デフォルト名の前に「-」を付けて、その後に値を指定します。
-クリーンYES):

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

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

定数テンプレート
定数に関するドキュメントを格納するテンプレートドキュメントの名前を指定します。
プロジェクト内のすべてのファイルから挿入する必要があります。これは、
ソースコードは多くのファイルに散在しており、それらを1つにまとめる必要がある
基本的なテンプレート文書（
個々の定数ドキュメントが挿入されている）には、
必要に応じて、autogsdocは簡単なテンプレートを生成します（これは
ファイルが存在しない場合は、自動的に挿入されます。挿入はすぐに行われます。
前 バック 要素（または、要素が存在しない場合は、
ボディ テンプレートに要素を追加します。

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

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

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

インスタンス変数終了時
このフラグが設定されている場合、HTMLジェネレータはインスタンス変数ドキュメントを配置するように指示します。
授業の始めではなく終わりに行う。これは、
保護されたインスタンス変数は二次的な関心事に過ぎない
クラスの一般ユーザー。

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


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

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

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

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

依存関係を無視
プログラムがファイルを無視するかどうかを指定するために使用できるブール値
変更時刻とファイルの再生成を繰り返す。
依存関係のチェックを自ら管理することが期待される「make」システム。

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

マクロテンプレート
マクロに関するドキュメントを記述するテンプレートドキュメントの名前を指定します。
プロジェクト内のすべてのファイルから挿入できます。マクロコードが散在している場合に便利です。
多数のファイルを管理し、1か所にまとめる必要があります。
基本テンプレート文書（個々のマクロ文書がここに追加される）が
挿入された情報には、必要な他のすべての情報が含まれていますが、便宜上
autogsdocは、簡単なテンプレート（編集可能）を生成します。
ファイルが存在しません。挿入は、 バック 要素（または
存在しない、終了直前 ボディ
テンプレートに要素を追加します。

依存関係を作成する
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 ファイルが見つかった場合は、それがインデックス内の名前のプレフィックスとして使用されます。注意。
現在文書化されているプロジェクトと同じ名前のシステムプロジェクトは、
このメカニズムによって含められるプロジェクトはありません。そのようなプロジェクトを含めたい場合は、
明示的に使用する -プロジェクト ...

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

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

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

冗長
詳細なデバッグ/警告出力をするかどうかを指定するブール値。
生産。

警告する
標準の警告出力（例：
文書化されていない方法（文書化されていない方法）が生成されます。

ワードマップ
この値は、ソースファイルにある識別子/キーワードをマッピングするために使用される辞書です。
言い換えれば、通常はこれを使用する必要はありませんが、時には役に立つことがあります
Cプリプロセッサマクロの使用によってパーサーが混乱するのを避けるため、
マクロを分かりやすいものに再定義します。
識別子は、次のどれかである必要があります - 別の識別子、空の文字列 - 値は
無視される、2つのスラッシュ（'//'） - 行の残りの部分は無視されます。辞書は
標準のPropertyList形式（
（OS XのXML形式）では、セミコロンを行区切りとして使い、単一の
引用。

インタードキュメント リンケージ

「上」のデフォルトは、
使用される他のドキュメントの「上」リンク。この名前にはパスまたは拡張子を含めることはできません。
通常、このデフォルトによって参照される文書は、手動で編集されたGSDoc文書である必要があります。
プロジェクトのインデックスを含む後ろのセクションが必要です。例:


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


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




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

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