lcn_api.h

/* Copyright 2005 The Apache Software Foundation or its licensors, as
 * applicable.
 *
 * Licensed 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.
 */

/** @mainpage Lucene4c API Documentation
 *
 * Lucene4c is a port of the Lucene search engine to C, built on top of the
 * Apache Portable Runtime.
 *
 * Unlike some other Lucene ports, Lucene4c does not stick to the API used
 * in the original Java based Lucene when a more idiomatic APR and C API makes
 * more sense. The goal is to remain compatible with the on-disk format used
 * by Java Lucene (currently that of Lucene 1.4.x) but to provide an API that
 * makes sense to programmers used to coding in C with APR.
 *
 * Currently Lucene4c is read-only, and only the lowest level portions of the
 * search engine has been implemented. The goal is to implement the remaining
 * parts of the search side of Lucene4c first, and then to begin work on
 * indexing support. In the meantime the Java Lucene must be used to create
 * the index searched by Lucene4c. 
 *
 * In order to make effective use of Lucene4c you will need to understand how
 * to use APR, which has its own API documentation at <a
 * href="http://apr.apache.org/docs/apr/">http://apr.apache.org/docs/apr/</a>.
 */

/* XXX eventually this will include the various header files a consumer of the
 * Lucene4c API would probably want to include, for now it just holds the intro
 * documentation for the doxygen docs. */

---