Changeset 5818 for trunk/doc/src/javadoc

Timestamp:

Oct 21, 2011, 1:15:41 PM (12 years ago)

Author:

Nicklas Nordborg

Message:

References #1590: Documentation cleanup

Some more sections in the developer documentation should now be up-to-date:

• Web services
• Parts of "The BASE API"
  • section 1: The public api of BASE.
  • section 2: The data layer api
  • section 3.9: Using files to store data
  • section 3.10: Sending signals to plug-ins

Sections 3.1 -- 3.8 are in the old format and will not be updated now.

"The Query API" and "The Dynamic API" are in the old format and will not be updated now.

"The Extensions API" need a big re-write.

Also fixed a lot of javadoc links leading to the developer documentation.

File:

• trunk/doc/src/javadoc/overview.html (modified) (1 diff)

trunk/doc/src/javadoc/overview.html

@@ -71 +71 @@
     the public API.
   </li>
-  
-  <li>
-    In <code>net.sf.basedb.util.overview</code> and sub-packages,
-    all classes and methods that are from BASE 2.10 (marked with @since 2.10 
-    or @version 2.10) are considered internal. We are expecting things to change
-    in those classes/methods in BASE 2.11 due to performance improvements that
-    are needed.
   </ul>