Documentation

Carrot² documentation is targeted mainly at developers and includes information about building the sources and using Carrot² core API. As the documentation may lag behind the newest code base, if you have a problem or question that is not covered, please contact us.

Carrot² developer documentation (architecture overview) is available in the following documents:

• Short architecture introduction
• Design requirements and architecture overview

For a step-by-step example of using Carrot² API directly in a Java application, checkout the source code from our Subversion repository located at https://carrot2.svn.sourceforge.net/svnroot/carrot2/trunk/ and look in the applications/carrot2-demo-api-example folder. The Example (JavaDoc), DirectDocumentFeedExample and LuceneExample (JavaDoc) classes provide verbose JavaDoc and in-code comments. You can also have a look at the full Carrot² API documentation.