OSDN Git Service

Merge commit '2234b50cfbe7c86237086a3bf4e62397814a390e'
[jindolf/JinParser.git] / src / main / java / jp / sourceforge / jindolf / parser / package-info.java
index f305b0f..62980cd 100644 (file)
-/*\r
- * JinParser パッケージコメント\r
- *\r
- * このファイルは、SunJDK5.0以降に含まれるJavadoc用に用意された、\r
- * 特別な名前を持つソースファイルです。\r
- * このファイルはソースコードを含まず、\r
- * パッケージコメントとパッケージ宣言のみが含まれます。\r
- *\r
- * Copyright(c) 2009 olyutorskii\r
- * $Id: package-info.java 894 2009-11-04 07:26:59Z olyutorskii $\r
- */\r
-\r
-/**\r
- * これは Jindolf プロジェクトにおける、\r
- * XHTML文書のパース部分を構成するパッケージです。\r
- *\r
- * JinParserライブラリは、CGIゲーム「人狼BBS」のクライアント制作者向けに\r
- * 作られたJavaライブラリです。\r
- * JinParserライブラリは、人狼BBSの専用クライアント開発プロジェクト\r
- * 「Jindolf」から派生しました。\r
- *\r
- * <hr>\r
- *\r
- * 任意のバイトストリームから、\r
- * デコードエラー情報付き文字列{@code DecodedContent}を得るには、\r
- * 次のようにします。\r
- * <pre>\r
- * {@code\r
- * InputStream is = .....\r
- * StreamDecoder decoder = new SjisDecoder();\r
- * ContentBuilder builder = new ContentBuilder();\r
- * decoder.setDecodeHandler(builder);\r
- * try{\r
- *     decoder.decode(is);\r
- * }catch(IOException e){\r
- *     // ERROR!\r
- * }catch(DecodeException e){\r
- *     // ERROR!\r
- * }\r
- * DecodedContent content = builder.getContent();\r
- * }\r
- * </pre>\r
- *\r
- * このようにして得られた文字列をパースして、\r
- * あなたの実装したハンドラ{@code YourHandler}に通知するには、\r
- * 以下のようにします。\r
- * <pre>\r
- * {@code\r
- * HtmlParser parser = new HtmlParser();\r
- * HtmlHandler handler = new YourHandler();\r
- * parser.setBasicHandler(handler);\r
- * parser.setTalkHandler(handler);\r
- * parser.setSysEventHandler(handler);\r
- * try{\r
- *     parser.parseAutomatic(content);\r
- * }catch(HtmlParseException e){\r
- *     // ERROR!\r
- * }\r
- * }\r
- * </pre>\r
- *\r
- * ハンドラ内部で、パース元となった文字列の一部を切り出したい場合は、\r
- * {@code EntityConverter}を使うのが便利です。\r
- *\r
- * <hr>\r
- *\r
- * <p>\r
- * The MIT License\r
- * </p>\r
- * <p>\r
- * Copyright(c) 2009 olyutorskii\r
- * </p>\r
- * <p>\r
- * Permission is hereby granted, free of charge, to any person obtaining a\r
- * copy of this software and associated documentation files (the "Software"),\r
- * to deal in the Software without restriction, including without limitation\r
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,\r
- * and/or sell copies of the Software, and to permit persons to whom the\r
- * Software is furnished to do so, subject to the following conditions:\r
- * </p>\r
- * <p>\r
- * The above copyright notice and this permission notice shall be included in\r
- * all copies or substantial portions of the Software.\r
- * </p>\r
- * <p>\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,\r
- * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\r
- * OTHER DEALINGS IN THE SOFTWARE.\r
- * </p>\r
- *\r
- * <hr>\r
- *\r
- * @see <a href="http://jindolf.sourceforge.jp/">\r
- * Jindolfポータルサイト</a>\r
- * @see <a href="http://sourceforge.jp/projects/jindolf/">\r
- * Jindolf開発プロジェクト</a>\r
- */\r
-\r
-package jp.sourceforge.jindolf.parser;\r
+/*
+ * JinParser パッケージコメント
+ *
+ * このファイルは、SunJDK5.0以降に含まれるJavadoc用に用意された、
+ * 特別な名前を持つソースファイルです。
+ * このファイルはソースコードを含まず、
+ * パッケージコメントとパッケージ宣言のみが含まれます。
+ *
+ * License : The MIT License
+ * Copyright(c) 2009 olyutorskii
+ */
+
+/**
+ * これは Jindolf プロジェクトにおける、
+ * XHTML文書のパース部分を構成するパッケージです。
+ *
+ * <p>
+ * JinParserライブラリは、CGIゲーム「人狼BBS」のクライアント制作者向けに
+ * 作られたJavaライブラリです。
+ * JinParserライブラリは、人狼BBSの専用クライアント開発プロジェクト
+ * 「Jindolf」から派生しました。
+ * </p>
+ *
+ * <hr>
+ *
+ * <p>
+ * 任意のバイトストリームから、
+ * デコードエラー情報付き文字列{@code DecodedContent}を得るには、
+ * 次のようにします。
+ * <pre>
+ * {@code
+ * InputStream is = .....
+ * StreamDecoder decoder = new SjisDecoder();
+ * ContentBuilder builder = new ContentBuilder();
+ * decoder.setDecodeHandler(builder);
+ * try{
+ *     decoder.decode(is);
+ * }catch(IOException e){
+ *     // ERROR!
+ * }catch(DecodeException e){
+ *     // ERROR!
+ * }
+ * DecodedContent content = builder.getContent();
+ * }
+ * </pre>
+ * </p>
+ *
+ * <p>
+ * このようにして得られた文字列をパースして、
+ * あなたの実装したハンドラ{@code YourHandler}に通知するには、
+ * 以下のようにします。
+ * <pre>
+ * {@code
+ * HtmlParser parser = new HtmlParser();
+ * HtmlHandler handler = new YourHandler();
+ * parser.setBasicHandler(handler);
+ * parser.setTalkHandler(handler);
+ * parser.setSysEventHandler(handler);
+ * try{
+ *     parser.parseAutomatic(content);
+ * }catch(HtmlParseException e){
+ *     // ERROR!
+ * }
+ * }
+ * </pre>
+ * </p>
+ *
+ * <p>
+ * ハンドラ内部で、パース元となった文字列の一部を切り出したい場合は、
+ * {@code EntityConverter}を使うのが便利です。
+ * </p>
+ *
+ * <hr>
+ *
+ * <p>
+ * The MIT License
+ * </p>
+ * <p>
+ * Copyright(c) 2009 olyutorskii
+ * </p>
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ * </p>
+ * <p>
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * </p>
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ * </p>
+ *
+ * <hr>
+ *
+ * @see <a href="http://jindolf.osdn.jp/">
+ * Jindolfポータルサイト</a>
+ * @see <a href="https://osdn.jp/projects/jindolf/devel/">
+ * Jindolf開発プロジェクト</a>
+ */
+
+package jp.sourceforge.jindolf.parser;
+
+/* EOF */