aboutsummaryrefslogtreecommitdiffstats
path: root/src/documentation/content/xdocs/apidocs/index.xml
blob: 8266786b10266837590be6f44cd6ade6b2795dc0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
<?xml version="1.0" encoding="UTF-8"?>
<!--
   ====================================================================
   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.
   ====================================================================
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "document-v20.dtd">

<document>
  <header>
    <title>Apache POI™ - Javadocs</title>
    <authors>
      <person id="PD" name="POI Developers" email="dev@poi.apache.org" />
    </authors>
  </header>

  <body>
    <section><title>Apache POI Javadocs</title>
  <p>
   The Javadocs for the latest (development) version of Apache POI
   can be <a href="dev/index.html">accessed online here</a>, or build
   from a <a href="site:git">source code checkout</a>
   by running the <em>javadocs</em> Ant task. The
   <a href="dev/index.html">latest (development) Javadocs</a> are generally
   updated every few weeks, so may lag the most recent development slightly.
  </p>
  <p>
   For recent releases, the Javadocs for the latest stable release
   each the family can also be browsed online:
  </p>
  <ul>
    <li><a href="ext:apidocs/v50">Apache POI 5.0.x Javadocs</a></li>
    <li><a href="ext:apidocs/v41">Apache POI 4.1.x Javadocs</a></li>
    <li><a href="ext:apidocs/v40">Apache POI 4.0.x Javadocs</a></li>
    <li><a href="ext:apidocs/v317">Apache POI 3.17 Javadocs</a></li>
  </ul>

  <section><title>Older Releases</title>
  <p>
    For every release of Apache POI, the specific Javadocs for that
    version are available with the release.
  </p>
  <p>
    Maven / Gradle / IDE users are able to fetch the javadocs for each
    of the Apache POI jars from Maven Central (or your preferred Maven
    mirror). These are made available with the <em>javadoc</em> classifier,
    e.g. <em>group: 'org.apache.poi', name: 'poi', version: '4.1.1',
           classifier: 'javadoc'</em>
  </p>
  <p>
    If you have downloaded the <em>binary (bin)</em> release, then you
    can find the Javadocs within the download in the <em>/docs/apidocs/</em>
    folder.
  </p>
  <p>
    If you have downloaded the <em>source (src)</em> release, then you
    need to build your own copy. Run the <em>javadocs</em> ant task
    to have the Javadocs built, the build will tell you the output
    directory at the end (it varies slightly between POI versions).
  </p>
  </section>
</section>
</body>
  <footer>
    <legal>
      Copyright (c) @year@ The Apache Software Foundation All rights reserved.
      <br />
      Apache POI, POI, Apache, the Apache feather logo, and the Apache
      POI project logo are trademarks of The Apache Software Foundation.
    </legal>
  </footer>
</document>