GNOME.org
 

API doc template tweaks

Here are some minor namespace tweaks and grammar fixes for the API
docs.  Feel free to commit.

John

-- 
dusk ravendusk org                            http://www.gnome.org
jsheets codeweavers com                  http://www.worldforge.org
jsheets users sourceforge net     http://openbooks.sourceforge.net
               http://advogato.org/person/jsheets

                   Writing Gnome Applications
          http://www.aw.com/cseng/titles/0-201-65791-0/

Index: ChangeLog
===================================================================
RCS file: /cvs/gnome/bonobo/ChangeLog,v
retrieving revision 1.956
diff -u -r1.956 ChangeLog
--- ChangeLog	2001/02/09 18:10:41	1.956
+++ ChangeLog	2001/02/14 15:57:50
@@ -1,3 +1,17 @@
+2001-02-14  John R. Sheets  <dusk ravendusk org>
+
+	* doc/api/bonobo-decl.txt: 
+	* api/tmpl/bonobo-canvas-component.sgml:
+	* api/tmpl/bonobo-canvas-item.sgml:
+	* api/tmpl/bonobo-listener.sgml:
+	* api/tmpl/bonobo-object-client.sgml:
+	* api/tmpl/bonobo-object.sgml:
+	* api/tmpl/bonobo-stream-memory.sgml:
+	* api/tmpl/bonobo-stream.sgml:
+	* api/tmpl/bonobo-transient.sgml:
+	* api/tmpl/bonobo-view.sgml: Update API template docs to remove
+	relics of old pre-namespace changes, plus some language tweaks.
+
 2001-02-09  Cody Russell  <bratsche gnome org>
 	* bonobo/bonobo-ui-engine-config.c: Remove the Cancel button.
 	Since this dialog makes changes in real time, this button serves
Index: doc/api/bonobo-decl.txt
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/bonobo-decl.txt,v
retrieving revision 1.5
diff -u -r1.5 bonobo-decl.txt
--- doc/api/bonobo-decl.txt	2000/12/04 07:21:34	1.5
+++ doc/api/bonobo-decl.txt	2001/02/14 15:58:22
@@ -1845,7 +1845,6 @@
 	 */
 	void  (*query_interface) (BonoboObject *object, const char *repo_id,  CORBA_Object      *retval);
 	void  (*system_exception)(BonoboObject *object, CORBA_Object cobject, CORBA_Environment *ev);
-	void  (*object_gone)     (BonoboObject *object, CORBA_Object cobject, CORBA_Environment *ev);
 } BonoboObjectClass;
 </TYPEDEF>
 <FUNCTION>
Index: doc/api/tmpl/bonobo-canvas-component.sgml
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/tmpl/bonobo-canvas-component.sgml,v
retrieving revision 1.3
diff -u -r1.3 bonobo-canvas-component.sgml
--- doc/api/tmpl/bonobo-canvas-component.sgml	2000/12/04 07:21:34	1.3
+++ doc/api/tmpl/bonobo-canvas-component.sgml	2001/02/14 15:58:23
@@ -7,10 +7,10 @@
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-  The BonoboCanvasComponent objects are used to wrap a GnomeCanvasItems
-  and export them to a container application.  Typically the
+  The BonoboCanvasComponent objects are used to wrap GnomeCanvasItems
+  and export them to container applications.  Typically the
   bonobo_component_canvas_new() function will be invoked in a callback
-  from a BonoboEmbeddable object.  Like this:
+  from a BonoboEmbeddable object.
 </para>
 
 <para>
@@ -21,7 +21,7 @@
     <programlisting>
 
 /*
- * Here is where the GnomeCanvasItem (in this case an ellipse
+ * Here is where the GnomeCanvasItem (in this case an ellipse)
  * is created and wrapped in a BonoboCanvasComponent.
  *
  * This function is invoked on demand on the embeddable
Index: doc/api/tmpl/bonobo-canvas-item.sgml
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/tmpl/bonobo-canvas-item.sgml,v
retrieving revision 1.3
diff -u -r1.3 bonobo-canvas-item.sgml
--- doc/api/tmpl/bonobo-canvas-item.sgml	2000/12/04 07:21:34	1.3
+++ doc/api/tmpl/bonobo-canvas-item.sgml	2001/02/14 15:58:24
@@ -2,19 +2,19 @@
 BonoboCanvasItem
 
 <!-- ##### SECTION Short_Description ##### -->
-A GNOME Canvas Item that can be used to embbed remote Bonobo GNOME
+A GNOME Canvas Item that can be used to embed remote Bonobo GNOME
 Canvas Items.
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
    The Bonobo Canvas Item is a Canvas item that will allow you to
-   embbed an arbitrary Canvas Item that lives in in a remote
+   embed an arbitrary Canvas Item that lives in in a remote
    Embeddable.  On the remote end, the #BonoboCanvasComponent class is
    used to wrap an arbitrary #GnomeCanvasItem and export it. 
 </para>
 
 <para>
-   This allows arbitrarly shaped components to be inserted into an
+   This allows arbitrarily shaped components to be inserted into an
    application.  Both Xlib and AA canvas items are supported.
 </para>
 
Index: doc/api/tmpl/bonobo-listener.sgml
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/tmpl/bonobo-listener.sgml,v
retrieving revision 1.1
diff -u -r1.1 bonobo-listener.sgml
--- doc/api/tmpl/bonobo-listener.sgml	2000/12/16 00:27:42	1.1
+++ doc/api/tmpl/bonobo-listener.sgml	2001/02/14 15:58:24
@@ -16,16 +16,16 @@
 
 <para>
    Once created, the BonoboListener object needs to be attached to a
-   remote IDL:Bonobo/EventSource:1.0 server.  This done by passing the
+   remote IDL:Bonobo/EventSource:1.0 server.  This is done by passing the
    CORBA Object reference of the BonoboListener to the addListener
    method in the IDL:Bonobo/EventSource:1.0.  
 </para>
 
 <para>
    The BonoboListener object allows the user to specify a callback
-   function to be invoked when an event is emmited by the
+   function to be invoked when an event is emitted by the
    IDL:Bonobo/EventSource:1.0 server.  The BonoboListener object also
-   emits the "event_notify" Gtk+ signal, which allows you to connnect
+   emits the "event_notify" Gtk+ signal, which allows you to connect
    multiple code segments to the same event notification. 
 </para>
 
@@ -60,7 +60,7 @@
          */
         reference = bonobo_object_corba_objref (keyboard_listener);
         Bonobo_EventSource_addListener (keyboard, reference);
-
+}
       </programlisting>
     </informalexample>
 
Index: doc/api/tmpl/bonobo-object-client.sgml
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/tmpl/bonobo-object-client.sgml,v
retrieving revision 1.2
diff -u -r1.2 bonobo-object-client.sgml
--- doc/api/tmpl/bonobo-object-client.sgml	2000/12/04 07:21:34	1.2
+++ doc/api/tmpl/bonobo-object-client.sgml	2001/02/14 15:58:25
@@ -7,38 +7,23 @@
 <!-- ##### SECTION Long_Description ##### -->
 <para>
   The #BonoboObjectClient object is used primarly to activate Bonobo
-  components (mainly by using gnome_object_activate ()).  The CORBA
+  components (mainly by using bonobo_object_activate ()).  The CORBA
   object reference to the Bonobo object is wrapped in a #BonoboObject.
 </para>
 
 <para>
   The #BonoboObjectClient object is also used to wrap an arbitrary
   Bonobo::Unknown CORBA object reference into a #BonoboObject (by using
-  gnome_object_client_from_corba()).
+  bonobo_object_client_from_corba()).
 </para>
 
 <para>
-  The main activation entry point is the gnome_object_activate()
+  The main activation entry point is the bonobo_object_activate()
   function.  This is a high-level routine that knows how to activate
-  components or activate and restore components.  Internally
-  gnome_object_activate() checks whether its argument is a moniker_url
-  or a GOAD-ID and depending on this it invokes
-  gnome_object_activate_with_goad_id() or gnome_object_restore_from_url().
-</para>
-
-<para>
-  The gnome_object_activate_with_goad_id() routine basically uses
-  GNORBA's goad_server_activate_with_id() to launch the component ( or
-  launch the factory implementing the component and requesting from
-  the factory a new instance).
-</para>
-
-<para>
-  The gnome_object_restore_from_url() takes a textual moniker url
-  description (See #BonoboMoniker) that represents a specific object
-  that is defined at least by a component and a url to restore its
-  state from.  Optionally, you can specific a subobject to request
-  from the resulting object.
+  components or activate and restore components.  bonobo_object_activate()
+  uses the supplied OAFIID to activate the object with OAF (GOAD 
+  activation is no longer supported).  If you want to activate an 
+  object with a moniker, use bonobo_get_object() instead.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
Index: doc/api/tmpl/bonobo-object.sgml
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/tmpl/bonobo-object.sgml,v
retrieving revision 1.2
diff -u -r1.2 bonobo-object.sgml
--- doc/api/tmpl/bonobo-object.sgml	2000/12/04 07:21:34	1.2
+++ doc/api/tmpl/bonobo-object.sgml	2001/02/14 15:58:27
@@ -85,14 +85,14 @@
   For example, a help browser can load an HTML renderer component and
   ask this component which sort of features are supported by it:
   <programlisting>
-_animations (BrowserHTML html)
-
+stop_animations (BrowserHTML html)
+{
   BrowserControl control
 
   control = html->query_interface ("IDL:Browser/Control:1.0");
   if (control)
           control->stop_animations ();
-
+}
   </programlisting>
 </para>
 
@@ -117,7 +117,7 @@
 
 <para>
   Other implementations reuse this implementation by listing on their
-  VEPV tables the gnome_object_epv entry point vector.
+  VEPV tables the bonobo_object_epv entry point vector.
 </para>
 
 <para>
@@ -177,13 +177,13 @@
 
 <para>
   #BonoboObject provides a mapping from the servant to the #BonoboObject
-  by using the gnome_object field in the structure.  Typically in the
+  by using the bonobo_object field in the structure.  Typically in the
   C CORBA binding, per-servant information is piggy-backed to the POA
   servant.  With the BonoboObject setup per-servant information is
   typically attached to the BonoboObject (by using the regular
   inheritance mechanism of Gtk+).  Going from a
   #PortableServer_Servant to the actual #BonoboObject is accomplished 
-  using the gnome_object_from_servant() routine.  
+  using the bonobo_object_from_servant() routine.  
 </para>
 
 <para>
Index: doc/api/tmpl/bonobo-stream-memory.sgml
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/tmpl/bonobo-stream-memory.sgml,v
retrieving revision 1.3
diff -u -r1.3 bonobo-stream-memory.sgml
--- doc/api/tmpl/bonobo-stream-memory.sgml	2000/12/04 07:21:34	1.3
+++ doc/api/tmpl/bonobo-stream-memory.sgml	2001/02/14 15:58:30
@@ -3,7 +3,7 @@
 
 <!-- ##### SECTION Short_Description ##### -->
 
-In-memory implementaiton of Bonobo::Stream interface.
+In-memory implementation of Bonobo::Stream interface.
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
@@ -21,7 +21,7 @@
      <title>Sample BonoboStreamMem usage</title>
 
      <programlisting>
-BonoboStream *make_bonbo_stream_on_string (char *string)
+BonoboStream *make_bonobo_stream_on_string (char *string)
 {
     return bonobo_stream_mem_create (string, strlen (string), TRUE, FALSE);
 }
Index: doc/api/tmpl/bonobo-stream.sgml
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/tmpl/bonobo-stream.sgml,v
retrieving revision 1.3
diff -u -r1.3 bonobo-stream.sgml
--- doc/api/tmpl/bonobo-stream.sgml	2000/12/04 07:21:34	1.3
+++ doc/api/tmpl/bonobo-stream.sgml	2001/02/14 15:58:30
@@ -43,7 +43,7 @@
 <!-- ##### MACRO BONOBO_STREAM_TYPE ##### -->
 <para>
   Returns the GtkType associated with the
-  <classname>GnomeStream</classname> object
+  <classname>BonoboStream</classname> object
 </para>
 
 
Index: doc/api/tmpl/bonobo-transient.sgml
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/tmpl/bonobo-transient.sgml,v
retrieving revision 1.3
diff -u -r1.3 bonobo-transient.sgml
--- doc/api/tmpl/bonobo-transient.sgml	2000/12/04 07:21:34	1.3
+++ doc/api/tmpl/bonobo-transient.sgml	2001/02/14 15:58:30
@@ -24,7 +24,7 @@
 <para>
    For example, consider the case in which a large list of objects
    needs to be returned to a client application.  For example, an
-   object reference could returned for every file on a directory.
+   object reference could be returned for every file on a directory.
    But it would be wasteful to keep one server running for each file.
    And given that the program has all the information available to
    create the servers on demand, you want to use this system.
@@ -107,7 +107,7 @@
         servant = g_new0 (MyServant, 1);
         servant->vepv = my_servant_get_epv ();
         servant->my_data = g_strdup ("Hello world!");
-        POA_My_Iface__init ((PortableServer_Servant) servant, &ev);
+        POA_My_Iface__init ((PortableServer_Servant) servant, &amp;ev);
         return servant;
 }
 
@@ -117,9 +117,9 @@
         CORBA_Environment ev;
 
         g_free (servant->my_data);
-        CORBA_exception_init (&ev);
-        POA_My_Iface__fini (servant, &ev);
-        CORBA_exception_free (&ev);
+        CORBA_exception_init (&amp;ev);
+        POA_My_Iface__fini (servant, &amp;ev);
+        CORBA_exception_free (&amp;ev);
 }
 
 CORBA_Object
Index: doc/api/tmpl/bonobo-view.sgml
===================================================================
RCS file: /cvs/gnome/bonobo/doc/api/tmpl/bonobo-view.sgml,v
retrieving revision 1.2
diff -u -r1.2 bonobo-view.sgml
--- doc/api/tmpl/bonobo-view.sgml	2000/12/04 07:21:35	1.2
+++ doc/api/tmpl/bonobo-view.sgml	2001/02/14 15:58:30
@@ -2,39 +2,41 @@
 BonoboView
 
 <!-- ##### SECTION Short_Description ##### -->
-View object for exporting a view of a GnomeEmbeddable component
+View object for exporting a view of a BonoboEmbeddable component
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-   #GnomeView objects are typically created on the view factory
-   callback of a #GnomeEmbeddable object.  Bonobo components should be
+   #BonoboView objects are typically created on the view factory
+   callback of a #BonoboEmbeddable object.  Bonobo components should be
    able to provide as many view objects as requested by the
-   #GnomeEmbeddable object on demand.
+   #BonoboEmbeddable object on demand.
 </para>
 
 <para>
-   It is the programmer responsability to keep the contents of all the
+   It is the programmer's responsibility to keep the contents of all the
    views displaying the same information (modulo per-view state, like
    the zoom factor).
 </para>
 
+<!-- FIXME: BonoboView API no longer matches following description -->
+
 <para>
    If your component provides menus, then you use the
-   gnome_view_set_ui_handler() on your view to provide it with a set
+   bonobo_view_set_ui_handler() on your view to provide it with a set
    of menus and toolbars.   You can also retrieve the container's UI
-   handler using gnome_view_get_ui_handler().
+   handler using bonobo_view_get_ui_handler().
 </para>
 
 <para>
    You can register verbs in the View by using the
-   gnome_view_register_verb().  When you want to stop supporting a
-   verb, you can use the gnome_view_unregister_verb().  Alternatively,
+   bonobo_view_register_verb().  When you want to stop supporting a
+   verb, you can use the bonobo_view_unregister_verb().  Alternatively,
    you can hook up to the "do_verb" signal and catch the verb requests
    on the signal handler.
 </para>
 
 <para>
-   #GnomeView objects get a chance to tell their containers their
+   #BonoboView objects get a chance to tell their containers their
    desired size by responding to the "size_query" signal.  They will
    get their size assigned later.  The size assignment happens on the
    GtkWidget using the normal Gtk+ size allocation procedure.
@@ -48,12 +50,12 @@
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
-   #GnomeViewFrame,  #GnomeEmbeddable, #BonoboWidget, bonobo_widget_new()
+   #BonoboViewFrame,  #BonoboEmbeddable, #BonoboWidget, bonobo_widget_new()
 </para>
 
 <!-- ##### MACRO BONOBO_VIEW_TYPE ##### -->
 <para>
-   Returns the GtkType associated with the #GnomeView object.
+   Returns the GtkType associated with the #BonoboView object.
 </para>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]