Talk:Swarm: documentation

From SwarmWiki

Jump to: navigation, search

This is the previous contents of Swarm: documentation, which is being replaced by a redirect to: Swarm: documentation main page--SFRailsback 18:22, 9 Feb 2006 (EST)

Main Page
Introduction to Swarm
Swarm software
Swarm FAQ
Stable release
Development snapshot
Applications
Documentation
Platforms
License
Swarm Development Group
Swarm community
Swarm resources

This page provides the official documentation for the Swarm libraries. See the Introduction to Swarm for a variety of other tutorials and introductory materials.

Contents

Swarm User Guide

The Swarm User Guide is available, although somewhat out of date.

Current reference documentation

Swarm API and reference documentation is consolidated in two documents.

Documentation Set for Swarm 2.2

This book (on-line or downloadable) includes the following sections:

  • A Brief Introduction to Swarm (not updated from previous versions)
  • Getting Started with Swarm (there is little here because up-to-date information is now maintained here on the Swarm wiki)
  • Reference Guide to Swarm 2.2, which is the Objective-C Swarm bible. It includes:
    • Swarm Changes and Compatibility: porting notes to assist in upgrading applications from previous versions to Swarm 2.1. No porting notes are available for Swarm 2.2 because there are few differences from 2.1.
    • Descriptions of all the classes, methods, and protocols in all the Swarm libraries. This is where you look to see what is in Swarm, and how to use it.
    • Indexes to the protocols and methods.

The Documentation Set is available:

Objective-C Reference Guide

Java Reference Guide to Swarm 2.2

The Java Reference Guide provides comprehensive documentation of all the packages and classes of Java Swarm 2.2. It is available on-line at: http://www.swarm.org/swarmdocs-2.2/refbook-java/

Alternatively, they are now available for offline reference:

Japanese Document Set

Retrieved from "http://www.swarm.org/index.php/Talk:Swarm:_documentation"