start adding some usage information in javadoc

git-svn-id: https://svn.code.sf.net/p/jackcess/code/jackcess/trunk@574 f203690c-595d-4dc9-a70b-905162fa7fd2

2 files changed, 113 insertions, 0 deletions

diff --git a/src/site/javadoc/stylesheet.css b/src/site/javadoc/stylesheet.css
new file mode 100644
index 0000000..ca1bb5e
--- /dev/null
+++ b/src/site/javadoc/stylesheet.css
@@ -0,0 +1,72 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+*/
+
+/* Javadoc style sheet */
+
+/* Define colors, fonts and other style attributes here to override the defaults  */
+
+/* Page background color */
+body { background-color: #FFFFFF }
+
+a:link, a:visited {
+ color: blue;
+ }
+
+a:active, a:hover, #leftcol a:active, #leftcol a:hover {
+ color: #f30 !important;
+ }
+
+a:link.selfref, a:visited.selfref {
+ color: #555 !important;
+ }
+
+.a td {
+ background: #ddd;
+ color: #000;
+ }
+
+/* Table colors */
+.TableHeadingColor     { background: #036; color:#FFFFFF } /* Dark blue */
+.TableSubHeadingColor  { background: #bbb; color:#fff } /* Dark grey */
+.TableRowColor         { background: #efefef } /* White */
+
+/* Font used in left-hand frame lists */
+.FrameTitleFont   { font-size: medium; font-family: normal; color:#000000 }
+.FrameHeadingFont { font-size: medium; font-family: normal; color:#000000 }
+.FrameItemFont    { font-size: medium; font-family: normal; color:#000000 }
+
+/* Example of smaller, sans-serif font in frames */
+/* .FrameItemFont  { font-size: 10pt; font-family: Helvetica, Arial, sans-serif } */
+
+/* Navigation bar fonts and colors */
+.NavBarCell1    { background-color:#ddd;}/* Light mauve */
+.NavBarCell1Rev { background-color:#888;}/* Dark Blue */
+.NavBarFont1    { font-family: Arial, Helvetica, sans-serif; color:#000000;}
+.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;}
+
+.NavBarCell2    { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
+.NavBarCell3    { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
+
+/* usage tag classes */
+.UsageGeneralHeader       { background: #efefef; color:#008000; text-decoration:underline }
+.UsageIntermediateHeader  { background: #efefef; color:#D4CF01; text-decoration:underline }
+.UsageAdvancedHeader      { background: #efefef; color:#D48201; text-decoration:underline }
+.UsageGeneral       { background: #efefef }
+.UsageIntermediate  { background: #efefef }
+.UsageAdvanced      { background: #efefef }
diff --git a/src/site/javadoc/taglets.properties b/src/site/javadoc/taglets.properties
new file mode 100644
index 0000000..b24a1e3
--- /dev/null
+++ b/src/site/javadoc/taglets.properties
@@ -0,0 +1,41 @@
+# basic taglets config
+Taglets.splash=false
+Taglets.verbose=false
+Taglets.debug=false
+Taglets.drivers= drivers/j2se15.jar, drivers/j2se14.jar
+
+# custom usage formatting
+Taglets.shutdown.usage-tag= net.sourceforge.taglets.simple.shutdown.RegexReplacer
+Taglets.shutdown.usage-tag.files= **/*.html
+Taglets.shutdown.usage-tag.token.0=_general_method_
+Taglets.shutdown.usage-tag.value.0=<span class="UsageGeneral"><span class="UsageGeneralHeader">General</span>: This method is general use.</span>
+
+Taglets.shutdown.usage-tag.token.1=_intermediate_method_
+Taglets.shutdown.usage-tag.value.1=<span class="UsageIntermediate"><span class="UsageIntermediateHeader">Intermediate</span>: This method requires moderate API knowledge.</span>
+
+Taglets.shutdown.usage-tag.token.2=_advanced_method_
+Taglets.shutdown.usage-tag.value.2=<span class="UsageAdvanced"><span class="UsageAdvancedHeader">Advanced</span>: This method is for advanced/internal use.</span>
+
+Taglets.shutdown.usage-tag.token.3=_general_class_
+Taglets.shutdown.usage-tag.value.3=<span class="UsageGeneral"><span class="UsageGeneralHeader">General</span>: This class is general use.</span>
+
+Taglets.shutdown.usage-tag.token.4=_intermediate_class_
+Taglets.shutdown.usage-tag.value.4=<span class="UsageIntermediate"><span class="UsageIntermediateHeader">Intermediate</span>: This class requires moderate API knowledge.</span>
+
+Taglets.shutdown.usage-tag.token.5=_advanced_class_
+Taglets.shutdown.usage-tag.value.5=<span class="UsageAdvanced"><span class="UsageAdvancedHeader">Advanced</span>: This class is for advanced/internal use.</span>
+
+Taglets.shutdown.usage-tag.token.6=_general_field_
+Taglets.shutdown.usage-tag.value.6=<span class="UsageGeneral"><span class="UsageGeneralHeader">General</span>: This field is general use.</span>
+
+Taglets.shutdown.usage-tag.token.7=_intermediate_field_
+Taglets.shutdown.usage-tag.value.7=<span class="UsageIntermediate"><span class="UsageIntermediateHeader">Intermediate</span>: This field requires moderate API knowledge.</span>
+
+Taglets.shutdown.usage-tag.token.8=_advanced_field_
+Taglets.shutdown.usage-tag.value.8=<span class="UsageAdvanced"><span class="UsageAdvancedHeader">Advanced</span>: This field is for advanced/internal use.</span>
+
+
+# apparently we need one "normal" tag or the taglets code gets unhappy
+Taglets.taglet.todo= net.sourceforge.taglets.simple.block.ParamBlockTaglet
+Taglets.taglet.todo.dl.class= tagletsTodo
+Taglets.taglet.todo.dl.header= <b>Todo:</b>