summaryrefslogtreecommitdiffstats
path: root/src/extension/dbus/document-interface.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/extension/dbus/document-interface.h')
-rw-r--r--src/extension/dbus/document-interface.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/extension/dbus/document-interface.h b/src/extension/dbus/document-interface.h
index 436f6b118..8cf9b7ec1 100644
--- a/src/extension/dbus/document-interface.h
+++ b/src/extension/dbus/document-interface.h
@@ -1,3 +1,20 @@
+/*
+ * This is where the implementation of the DBus based document API lives.
+ * All the methods in here (except in the helper section) are
+ * designed to be called remotly via DBus. application-interface.cpp
+ * has the methods used to connect to the bus and get a document instance.
+ *
+ * Documentation for these methods is in document-interface.xml
+ * which is the "gold standard" as to how the interface should work.
+ *
+ * Authors:
+ * Soren Berg <Glimmer07@gmail.com>
+ *
+ * Copyright (C) 2009 Soren Berg
+ *
+ * Released under GNU GPL, read the file 'COPYING' for more information
+ */
+
#ifndef INKSCAPE_EXTENSION_DOCUMENT_INTERFACE_H_
#define INKSCAPE_EXTENSION_DOCUMENT_INTERFACE_H_