1 files changed, 59 insertions, 0 deletions
diff --git a/o3d/plugin/idl/plugin.idl b/o3d/plugin/idl/plugin.idl
new file mode 100644
index 0000000..26a00b9
--- /dev/null
+++ b/o3d/plugin/idl/plugin.idl
@@ -0,0 +1,59 @@
+/*
+ * Copyright 2009, Google Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *     * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
+// This file contains the public interface specification for the plugin.
+
+[verbatim=js_header] %{
+  /*!
+   * \mainpage API Reference
+   *
+   * O3D is a plug-in for your browser. In order to make o3d produce 
+   * the graphics you see in the demos, you'll need to access the plug-in and its 
+   * components from within JavaScript. You can do so through a member variable 
+   * on the plug-in called \a client, representing the instance of o3d within 
+   * the plug-in.
+   *
+   * Here is how to access the client itself:
+   * \code
+   * g_client = document.o3d.client;
+   * \endcode
+   *
+   * where <code>document.o3d</code>
+   * represents the plug-in (rather than the Client instance within the plug-in). 
+   * Not much else can be done with the plug-in, so you will want to access 
+   * the \a client as shown above.
+   *
+   * Now that you know how to access the instance of o3d from your 
+   * JavaScript, check out the rest of the API for more information on how to 
+   * make o3d do what you want.
+   */
+%}