[seasar-javadoc:818] Re: XmlS2ContainerBuilder

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Sun, 25 Feb 2007 17:06:04 +0900
From:    yatsu <fusatsukatsujin ＠ tbc.t-com.ne.jp>
To:      Javadoc <seasar-javadoc ＠ ml.seasar.org>
Subject: [seasar-javadoc:817]  XmlS2ContainerBuilder

> XmlS2ContainerBuilderのJavaDoc記述いたしました。

ありがとうございます！！
以下，コメントです．

■ クラスコメント

>  * <p>
>  * このクラスに対し、変更を加えることによって、S2コンテナの構築をカスタマイズすることが出来ます。
>  * </p>
>  * <p>
>  * 例えば、新規の{@link org.seasar.framework.xml.TagHandler}を追加した{@link org.seasar.framework.container.factory.S2ContainerTagHandlerRule}を設定することによって、
>  * </p>
>  * </p>
>  * 設定ファイルをカスタマイズすることが出来ます。
>  * </p>

ここは全体で一つの段落でも十分な気がします．
特に，一つの文が 2 つめと 3 つめの段落に
分かれてしまってるのはちょっと．
改行を入れるだけなら <br> でお願いします．
# 文毎に改行入れるのもアレなので，ここでは不要かと．

■ PUBLIC_ID

>      * dtdと対応づけられるバージョン2.0のIDです。

これは

Seasar2.0以降でサポートされているDTDのパブリックIDです。

という感じの方がよさげ．
他のバージョンのパブリック ID も同様で．

■ DTD_PATH

>      * diconファイルの解析に利用されるバージョン2.0のdtdのパスです。

細かいですが，小文字の dtd は大文字の DTD でお願いします．
それから，「解析」よりは「検証」がいいですね．

■ getRule()

>      * S2ContainerTagHandlerRuleを返します。
>      * 
>      * @return タグとTagHandlerのマッピング情報

「〜を返します」の「〜」と @return は揃えちゃって
ください．この場合は

 * タグとTagHandlerのマッピング情報を返します。
 * 
 * @return タグとTagHandlerのマッピング情報

って感じで．
setter も同様．

■ addDtd(final String publicId, final String systemId)

>      * DTDマッピング情報を追加します。

頭に「dicon の検証で使用する」とか追加したいですね．
それから，マッピング情報は DTD のパブリック ID と，
クラスパスから取得可能な DTD のパスの組ということを
追記するとよいかと．

>      * @param publicId
>      *            公開DTDのID

これは「DTD のパブリックID」で．

■ clearDtd()

>      * DTDマッピング情報を消去します。

デフォルトの DTD を使用しない場合に呼び出します，
みたいなことを追記してください．

■ build(final String path)
■ include(final S2Container parent, final String path)

これらは S2ContainerBuilder の説明そのままになると
思うので，記述しない (Javadoc コメント無し) 方向で．


以上です．


-- 
<component name="koichik">
    <property name="fullName">"Koichi Kobayashi"</property>
    <property name="email">"koichik ＠ improvement.jp"</property>
    <property name="blog">"http://d.hatena.ne.jp/koichik"</property>
</component>