問題タブ [doclet]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
1 に答える
400 参照

enums - javado Doclet enum - 自分のドックレットで使用する列挙型から可能な値を取得する方法は?

javadoc を使用する場合、列挙型は通常次のように文書化されます。

私の問題は、JavaDoc Doclets を使用して、その列挙型 ( Javadoc ClassDoc ) の classDoc を取得できますが、可能な値のコメント、または可能な値自体を取得できないことです。誰かアイデアはありますか?

0 投票する
1 に答える
628 参照

javadoc - javadoc ドックレット: クラスから属性を取得する方法

ドックレットをいじっていて、次の問題に直面しています。クラスから属性を取得したいのですが、パラメーター メソッドが役立つと思いました。私のコードは次のようになります(メソッドの戻り値の型に対してそうしています):

私が得ているのは

メソッド myMethod の returnType は MyMethodResponse 型からのものです

多分私は何かが欠けています。ClassDoc.fields() メソッドは属性のすべてのリストを表示してくれませんか? それを行う方法はありますか?どうもありがとうございました。

0 投票する
1 に答える
239 参照

java - Javadoc ドックレットは nullary コンストラクター (コンパイラーが作成したデフォルトのコンストラクター) を識別できますか?

ソフトウェア アプリケーションの作成では、Javadoc にプラグインするドックレットを作成しています。Javadoc と作成された RootDoc の使用に関して私が抱えている問題の 1 つは、コンパイラによって作成された nullary コンストラクターが含まれていることです。ドックレットに提供された RootDoc を介してこれが発生したり、それらを識別したりするのを防ぐ方法はありますか? isSynthetic メソッドを発見した昨夜、私はこれで前進したと思っていましたが、nullary コンストラクターは明らかに合成ではありません。

0 投票する
1 に答える
2660 参照

javadoc - javadocドックレットをGradleします。ドックレットが見つかりません

私はGradleを初めて使用し、非常に独自の美しさのドックレットをgradleで使用しようとしています。私は次のタスクを実行しました:

それで、私は常に次のエラーになります:

私のドックレットへのパスであるoptions.docletpathがあることは知っていますが(しかし... srcまたはclass?)、説明が不足しているため、そこに何を置くべきか理解できません。docu

誰かが私にドクレットのパスを正しく設定して、私のかわいいドクレットを見つける方法を説明できますか?

御時間ありがとうございます!!

0 投票する
1 に答える
4241 参照

javadoc - javadocドックレットを使用したGradle:エラー - 無効なフラグ:ドックレット・タスクの実行時の-doctitle

次の gradle-javadoc-doclet タスクを実行しています。

(myJavadocs は、基本的な javadoc を生成する単なるタスクです) 次のようにコンソールで実行しています。

これを行うと、次のエラーが表示されます。

「doctitle」フラグは javadoc 仕様 ( Javadoc 1.3 Options ) のオプションの 1 つであるように見えますが、初期の javadoc バージョンにはありませんでした (「タイトル」フラグでした)。JDK (1.6) から tools.jar (hte javadoc がある場所) を使用しています。

私が間違っていることを誰かが知っていますか?

お時間をいただきありがとうございました!

ファローアップ -

その「doctitle」タグは標準ドックレット (私は独自のドックレットを実行しています) にあり、gradle によって追加されているようです (私のドックレットはそれを認識しません)。そのタグを取り除く方法を知っている人はいますか? または、それらのタグをドックレットに「含める」方法があるかどうかを知っていますか?

0 投票する
1 に答える
2290 参照

java - Javadoc doclet : "@Nullable" アノテーション (javax) を取得します。ドックレットでその注釈を取得する方法は?

私は独自のドックレットを作成しており、メソッドからのパラメーターが null 可能かどうかを示す必要があります。そのために、javax.annotation の @Nullable アノテーションを使用したいと考えています。Googleの人々がここで言うことのようなもの:

Doclet でその Phone パラメータの "nullable" アノテーションを取得する方法はありますか?

0 投票する
1 に答える
181 参照

javadoc - Auriga Doclet の出力でパッケージの順序を変更するにはどうすればよいですか?

Auriga Doclet 1.0を使用して JavaDoc ドキュメントを PDF として作成しています。

しかし、その生成された PDF には、アルファベット順に基づいて、Service、Response、VO のようなパッケージの順序が含まれています。

しかし、私はそれらを次のように並べる必要があります: 応答、サービス、VO。

どうすればこれを達成できますか?

0 投票する
3 に答える
1572 参照

java - 特別なドックレットでJavadocを実行するときのあいまいなIOException

これはドックレット実装固有の質問かもしれませんが、ここで扱っているのは本当にJavaDoc構成の問題だと思います。

yDoc UML Docletを機能させて、Antビルドの一部としてJavaアプリのUML図を生成しようとしています。私はプロジェクト(コミュニティ版)をダウンロードし、それらを適応させようとしましたが、それを完全に機能させることbuild-sample.xmlができません。

これが私のプロジェクトディレクトリ構造です:

ここにありbuild.xmlます:

タスクを実行すると、引数を指定ydocして「verbose」モードでAntを実行していても、Ant Consoleでタスクが呼び出され、その後に「Generating Javadoc」というログステートメントが表示され、詳細出力から約20行が逆流します。paramsが返ってきたら、「Javadocの実行」という最終的なログメッセージが表示されます。次に、次の驚くほど漠然とした:-v[ydoc]yDocIOException

Antから詳細を取得する方法はありますか?例外で参照しているファイルまたはディレクトリを見つけるには?これまでにJavaDoc/yDocの達人がこれに遭遇したことはありますか?プロジェクトのディレクトリ構造が正しく設定されていませんか、それともAntビルドが探しているものとは異なりますか?私は自分の属性が正しく設定されていて、正しいパスセパレーターを使用していると信じdoclet/pathています(私はUbuntu Linuxを使用しています)。私の人生では、ここからどこに行くべきか、またはここで根本的な問題を診断する方法を理解することはできません!前もって感謝します!

編集/更新

これまでの提案に感謝します。私はEclipseを完全に廃止しています(ビルドに関する限り、コマンドラインからAntを実行するだけです。これは今のところ問題ありません。これを行うと、ビルドが成功します(したがって、Eclipseが少なくとも部分的に原因でした) )、ただし、yDocの生成はまだありません。

さて、verbos(-v)オプションを使用してターミナルからAntを実行すると、次のように表示されます。

同じように見えますが、クラスが異なる何百もの警告:

それらを数百回実行すると、次の出力が得られます(ソースツリー内のすべてのパッケージに対してこれらのうちの1つ)。

最後に、冗長ビルド出力の最後のセクション:

さらに、正しく実行されていれば、すべてのJavaDocをuml-doclet/プロジェクトルートのディレクトリの下に配置する必要があります。そんなことはしません!

したがって、さらにいくつかのことが起こっているように見えます。

  1. JavaDocは、サードパーティの依存関係(Spring、Camelなど)を認識できません。したがって、何百もの警告のリスト
  2. 文書化するソースが見つかりません

繰り返しになりますが、賞金は私がこれを機能させるのを手伝ってくれる人に与えられます。これまでのすべての助けにもう一度感謝します!

0 投票する
1 に答える
57 参照

maven - 継承に基づくクラスを含む Java ドキュメント

私が「Java docs」を書いたことに注意してください.javadocユーティリティが私が求めているものを達成するとは必ずしも期待していないためです(私が使用しているmaven-javadoc-pluginは言うまでもありません)。

特定のインターフェイスを拡張/実装するクラスのみを含むドキュメント サイトを作成する必要がありますが、残念ながら、そのようなクラスは、パッケージ パスでフィルタリングすることによってこれを実行できる論理パッケージ構造に配置されていないようです。

助言がありますか?

0 投票する
1 に答える
2143 参照

java - ブートストラップテーマで JavaDoc を生成するには?

Bootstrap テーマで api doc を生成したいのですが、どうすれば実現できますか?