Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    View page history    Add new chapter    Reorder page    Raw


新しいdoclet

New Doclet

Gerald Boersmaによって作られた、強化された新しいdocletが利用可能になりました。

新しいdocletは既存のレガシー版よりも多くのオプションを備えています。

詳細はこちら
A new enhanced doclet (written by Gerald Boersma) is now available.

It has much more option than the legacy previous one.

You will find detailed instructions here.

レガシー版Javadoc

Legacy Javadoc

javadocのツールがドキュメンテーションを生成する際、doc-filesディレクトリに含まれるすべてのファイルがjavadocにコピーされます(How to Write Doc Comments for the Javadoc Toolを参照)。

この機能を次のように利用することができます:

package net.demo1;
/**
* Demonstration for PlantUML.
* <p>
* Example of use:
* <p>
* <img src="doc-files/image1.png">
*/
/*
* @startuml doc-files/image1.png
* Bob -> Alice : hello
* Alice --> Bob : OK
* @enduml
*/
public class Demo1 {

}

javadocの前にPlantUMLを実行しておけば、doc-filesディレクトリにimage1.pngが生成されます。

その後でjavadocツールを実行することで、次の結果が得られます:

図の定義自体はjavadocではない通常のコメント内に書いてあることに注意してください。それはHTMLには出力されません。

このように、非常に簡単に、UMLダイアグラムをjavaドキュメンテーションに含めることができるようになりました。
When the javadoc tools build the documentation, it copies all files included in the doc-files directory to the javadoc . (see How to Write Doc Comments for the Javadoc Tool).

You can take advantage of this feature like this:

package net.demo1;
/**
* Demonstration for PlantUML.
* <p>
* Example of use:
* <p>
* <img src="doc-files/image1.png">
*/
/*
* @startuml doc-files/image1.png
* Bob -> Alice : hello
* Alice --> Bob : OK
* @enduml
*/
public class Demo1 {

}

If you run PlantUML before the Javadoc, it will generate image1.png in the directory doc-files .

Then, when you launch the Javadoc tool, you will have the following result:

Note that the definition of the image itself is in a non-javadoc comment, so that it is not exported to HTML.

As you can see, adding UML diagrams into java documentation is now really easy.


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.