source: trunk/doc/src/javadoc/overview.html @ 8053

Last change on this file since 8053 was 8001, checked in by Nicklas Nordborg, 16 months ago

Fix issues with javadoc generation when building with Java 15+

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 2.5 KB
Line 
1<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
3<!--
4    $Id: overview.html 8001 2021-08-11 06:36:22Z nicklas $
5
6    Copyright (C) 2007 Nicklas Nordborg
7
8    This file is part of BASE - BioArray Software Environment.
9    Available at http://base.thep.lu.se/
10
11    BASE is free software; you can redistribute it and/or modify it
12    under the terms of the GNU General Public License as published by
13    the Free Software Foundation; either version 3 of the License, or
14    (at your option) any later version.
15
16    BASE is distributed in the hope that it will be useful, but
17    WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19    General Public License for more details.
20
21    You should have received a copy of the GNU General Public License
22    along with BASE. If not, see <http://www.gnu.org/licenses/>.
23-->
24
25<body>
26  <h1>The BASE API</h1>
27
28  <p>
29  The <b>Public API</b> is intended to be used by client application
30  or plug-in developers. We guarantee a certain degree of stability
31  among the classes and methods in the public API. See documentation
32  on the <a href="https://base.thep.lu.se/chrome/site/doc/docbook/html/developerdoc/api/api_overview.html"
33    >BASE web site</a> for more information.
34  Methods that have been tagged as <code>@deprecated</code> should be considered
35  part of the internal API and may be removed without warning in
36  a later release.
37  </p>
38
39  <p>
40  The <b>Extension API</b> is intended to be used by developers extending
41  the internal BASE functionality. The classes and interfaces in these packages
42  are not intended to be used by plug-ins or client applications.
43  </p>
44 
45  <p>
46  The <b>Internal API</b> contains code used by the internal implementation
47  of BASE. Client applications and plug-ins should not use the classes
48  and methods in theese packages.
49  </p>
50 
51  <p>
52  The <b>Mixed Public and Internal API</b> packages contains some
53  classes that belong to the <b>Public API</b> and some classes that
54  belong to the <b>Internal API</b>.
55  </p>
56 
57  <ul>
58  <li>
59    In <code>net.sf.basedb.core.data</code> the <code>BatchableData</code>
60    interface and all classes that implements it part of the public API.
61  </li>
62 
63  <li>
64    The <code>net.sf.basedb.clients.web.util.HTML</code> is part of
65    the public API.
66  </li>
67 
68  <li>
69    The <code>net.sf.basedb.clients.web.Base</code> and
70    <code>net.sf.basedb.clients.web.WebException</code> are part of
71    the public API.
72  </li>
73  </ul>
74 
75  <p>
76  All other classes in are part of the internal API.
77  </p>
78   
79</body>
Note: See TracBrowser for help on using the repository browser.