1 files changed, 59 insertions, 0 deletions
diff --git a/src/lib/AbiDocument.cpp b/src/lib/AbiDocument.cpp
new file mode 100644
index 0000000..4b55812
--- /dev/null
+++ b/src/lib/AbiDocument.cpp
@@ -0,0 +1,59 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the libabw project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#include <libabw/libabw.h>
+
+/**
+\mainpage libwpd documentation
+This document contains both the libwpd API specification and the normal libwpd
+documentation.
+\section api_docs libwpd API documentation
+The external libwpd API is provided by the AbiDocument class. This class, combined
+with the librevenge::RVNGTextInterface class, are the only two classes that will be of interest
+for the application programmer using libwpd.
+\section lib_docs libwpd documentation
+If you are interrested in the structure of libwpd itself, this whole document
+would be a good starting point for exploring the interals of libwpd. Mind that
+this document is a work-in-progress, and will most likely not cover libwpd for
+the full 100%.
+*/
+
+/**
+Analyzes the content of an input stream to see if it can be parsed
+\param input The input stream
+\return A confidence value which represents the likelyhood that the content from
+the input stream can be parsed
+*/
+bool AbiDocument::isFileFormatSupported(librevenge::RVNGInputStream *input)
+{
+	if (!input)
+		return false;
+	return false;
+}
+
+/**
+Parses the input stream content. It will make callbacks to the functions provided by a
+librevenge::RVNGTextInterface class implementation when needed. This is often commonly called the
+'main parsing routine'.
+\param input The input stream
+\param textInterface A librevenge::RVNGTextInterface implementation
+\param password The password used to protect the document or NULL if the document
+is not protected
+\return A value that indicates whether the conversion was successful and in case it
+was not, it indicates the reason of the error
+*/
+bool AbiDocument::parse(librevenge::RVNGInputStream *input, librevenge::RVNGTextInterface *textInterface)
+{
+	if (!input)
+		return false;
+	if (!textInterface)
+		return false;
+	return false;
+}
+/* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */