2016-06-23 11 views
0

私たちは3つの異なる言語で提供するOSXのAPIを持っています。 Objective-C、C++、およびJava。MavenのDoxygenスタイルメインページ

C++およびObjective C言語では、すべてのドキュメントにDoxygenを使用しています。サンプルページ(mainpage.h)には、クラスページに適用される見栄えの良いプレゼンテーションも用意されています。私は特にシンタックスカラーリングが好きです。

Java言語については、Mavenを使用しています。 Appleの開発環境はJavaにはあまり役立つものではないので、Mavenをドキュメントと適切なビルドシステムの両方に使用することができます。私の意見では、クラスページはDoxygenとよく似ていますが、主な例のページ(examples.apt)のプレゼンテーションはかなり単純で平凡ではありません。

私はページに色を追加する方法についての参考文献を探していましたが、実際には何も見つかりませんでした。

は私の質問:

誰もが適切な.aptファイル(examples.apt)またはsites.xmlファイルに着色を実装する方法の例を提供することはできますか?

+0

本当に.aptがついていますか?なぜマークダウンを使用しないのですか?さらに、どのサイトのスキンを使用していますか? – khmarbaise

答えて

2

Javadocをカスタマイズするための2つの主要な場所があります。 pom.xmlファイルの最初の部分です。 2番目の場所はsrc/main/javadocディレクトリにあります。 src/main/javadocディレクトリは通常、ディレクトリの最初のセットにはないので、自分で作成する必要があります。

いくつかのJavadoc設定方法については、https://github.com/BradleyRoss/tutorialsを参照してください。親モジュールのpom.xmlとチュートリアル共通モジュールのsrc/main/javadocディレクトリを見てください。

stylesheet.cssファイルを自分で置き換える方法については、https://maven.apache.org/plugins/maven-javadoc-plugin/examples/stylesheet-configuration.htmlを参照してください。それはおそらく色の選択のほとんどが行くところです。 Javadocプラグインの設定セクションでstylesheetfileとstylesheetタグを使用します。

Mavenは明らかに、JDKに付属するstylesheet.cssファイルの修正版を使用しています。 JDKとMavenのバージョンを比較して、変更可能なアイデアを得ることができます。

+0

私たちにはこれ以上の問題があることが判明しました。リソースフォルダは、サイトディレクトリにも書き込まれませんでした。我々は、pomファイルにサイトプラグインのバージョン番号を追加することを怠ったことを発見しました。いったんこれを実行すると、すべての機能が一体化し始めました。ビルドエラーを起こさずにsites.xmlにmaven-fluido-skinを追加することができました。これで構文カラーリングができました。それはもっと良く見えます。 – Miek