[gtk-doc] manual: fix spelling and make small clarifications.



commit 92ae5fc857f11611080205d27c8e26dce93d7e49
Author: Stefan Kost <ensonic users sf net>
Date:   Mon Jul 5 10:24:23 2010 +0300

    manual: fix spelling and make small clarifications.
    
    Correct typos and spelling as pointed out by  Alexander Saprykin. Fixes #622971.

 help/manual/C/gtk-doc-manual.xml |   64 +++++++++++++++++++------------------
 1 files changed, 33 insertions(+), 31 deletions(-)
---
diff --git a/help/manual/C/gtk-doc-manual.xml b/help/manual/C/gtk-doc-manual.xml
index 3c60c80..da15f2f 100644
--- a/help/manual/C/gtk-doc-manual.xml
+++ b/help/manual/C/gtk-doc-manual.xml
@@ -175,13 +175,13 @@
             code looking for declarations of functions, macros, enums, structs, and unions.
             It creates the file <filename>&lt;module&gt;-decl-list.txt</filename> containg a list of the
             declarations, placing them into sections according to which header file they
-            are in. On the first run this file is copied to <filename>&lt;module&gt;-sections.txt</filename>
+            are in. On the first run this file is copied to <filename>&lt;module&gt;-sections.txt</filename>.
             The author can rearrange the sections, and the order of the
             declarations within them, to produce the final desired order.
             The second file it generates is <filename>&lt;module&gt;-decl.txt</filename>.
             This file contains the full declarations found by the scanner. If for
-            some reason one would like some sybols to show up in the docs, where
-            the full declaration cannot be found by th scanner or the declaration
+            some reason one would like some symbols to show up in the docs, where
+            the full declaration cannot be found by the scanner or the declaration
             should appear differently, one can place enties similar to the ones in
             <filename>&lt;module&gt;-decl.txt</filename> into <filename>&lt;module&gt;-overrides.txt</filename>.
 
@@ -222,13 +222,13 @@
             or <filename class='directory'>xml/</filename> subdirectory.
             If the source code contains documentation on functions, using the
             special comment blocks, it gets merged in here. If there are no tmpl files used
-            it only reads takes docs from sources and introspection data.
+            it only reads docs from sources and introspection data.
           </para>
           <para>
             <application>gtkdoc-mkhtml</application> turns the SGML/XML files into HTML
             files in the <filename class='directory'>html/</filename> subdirectory.
             Likewise <application>gtkdoc-mkpdf</application> turns the SGML/XML files into a PDF
-            docuemnt called <filename>&lt;package&gt;.pdf</filename>.
+            document called <filename>&lt;package&gt;.pdf</filename>.
           </para>
           <para>
             Files in <filename class='directory'>sgml/</filename> or
@@ -364,7 +364,7 @@
 
     <para>
       The next sections describe what steps to perform to integrate GTK-Doc into
-      your project. Theses section assume we work on a project called 'meep'.
+      your project. Theses sections assume we work on a project called 'meep'.
       This project contains a library called 'libmeep' and
       an end-user app called 'meeper'.
     </para>
@@ -380,7 +380,7 @@
       </para>
 
       <para>
-        This can then look as show below:
+        This can then look as shown below:
         <example><title>Example directory structure</title>
           <programlisting>
 <![CDATA[
@@ -466,7 +466,7 @@ AC_CONFIG_MACRO_DIR(m4)
       </para>
 
       <para>
-        The next step is to edit the setting inside the <filename>Makefile.am</filename>.
+        The next step is to edit the settings inside the <filename>Makefile.am</filename>.
         All the settings have a comment above that describes their purpose.
         Most settings are extra flags passed to the respective tools. Every tool
         has a variable of the form <option>&lt;TOOLNAME&gt;_OPTIONS</option>.
@@ -477,8 +477,8 @@ AC_CONFIG_MACRO_DIR(m4)
       <!-- FIXME: explain options ? -->
 
       <para>
-        You may also want to enable GTK-Doc for the distcheckmake target. Just
-        add then one-liner show in the next example to you top-level
+        You may also want to enable GTK-Doc for the distcheck make target. Just
+        add the one line shown in the next example to your top-level
         <filename>Makefile.am</filename>:
       </para>
 
@@ -517,21 +517,23 @@ gtkdocize || exit 1
 
       <para>
         When running <application>gtkdocize</application> it copies
-        <filename>gtk-doc.make</filename> to you project root (or any directory
+        <filename>gtk-doc.make</filename> to your project root (or any directory
         specified by the <option>--docdir</option> option).
-        If also check you configure script for the <function>GTK_DOC_CHECK</function>
-        invocation.
+        It also checks you configure script for the <function>GTK_DOC_CHECK</function>
+        invocation. This macro can be used to pass extra parameters to
+        <application>gtkdocize</application>.
       </para>
 
       <para>
-        Historically GTK-Doc was gerating template files where developers entered the docs.
-        this turned out to be not so good. Since a few version GTK-Doc could also get all
-        the information from source comments.
-        Since GTK-Doc 1.9 the templates can be avoided. We encourage people to keep
+        Historically GTK-Doc was generating template files where developers entered the docs.
+        This turned out to be not so good (e.g. the need for having generated
+        files under version control).
+        Since GTK-Doc 1.9 the tools can get all the information from source comments
+        and thus the templates can be avoided. We encourage people to keep
         documentation in the code. <application>gtkdocize</application> supports now
         a <option>--flavour no-tmpl</option> option that chooses a makefile that skips
         tmpl usage totally. Besides adding the option directly to the command
-        invocation, they can be added also to a environment variable called <symbol>GTKDOCIZE_FLAGS</symbol>
+        invocation, they can be added also to an environment variable called <symbol>GTKDOCIZE_FLAGS</symbol>
         or set as a 2nd parameter in <symbol>GTK_DOC_CHECK</symbol> macro in the configure script.
         If you have never changed file in tmpl by hand and migrating from older gtkdoc versions,
         please remove the dir (e.g. from version control system).
@@ -593,8 +595,8 @@ make
     <para>
       GTK-Doc uses source code comment with a special syntax for code documentation.
       Further it retrieves information about your project structure from other
-      sources. During the next section you find all information about the syntax
-      of the comments.
+      sources. During the next section you will find all information about the
+      syntax of the comments.
     </para>
 
     <note>
@@ -747,7 +749,7 @@ make
  * @see_also: #MeepSettings
  * @stability: Stable
  * @include: meep/app.h
- * @Image: application.png
+ * @image: application.png
  *
  * The application class handles ...
  */
@@ -791,8 +793,8 @@ make
           <listitem>
             <para>
               Overrides the use of title as a section identifier. For GObjects
-              the &lt;title&gt; is used as a section_id and for other section it
-              is &lt;MODULE&gt;-&lt;title&gt;.
+              the &lt;title&gt; is used as a section_id and for other sections
+              it is &lt;MODULE&gt;-&lt;title&gt;.
             </para>
           </listitem>
         </varlistentry>
@@ -800,7 +802,7 @@ make
           <term>@see_also</term>
           <listitem>
             <para>
-              A list of symbols that are related to this section..
+              A list of symbols that are related to this section.
             </para>
           </listitem>
         </varlistentry>
@@ -896,8 +898,8 @@ make
         Each symbol (function, macro, struct, enum, signal and property) is
         documented in a separate block. The block is best placed close to the
         definition of the symbols so that it is easy to keep them in sync.
-        Thus function are usually documented in the c-source and macros, struct
-        and enum in the header file.
+        Thus functions are usually documented in the c-source and macros,
+        structs and enums in the header file.
       </para>
 
       <sect2><title>General tags</title>
@@ -1112,7 +1114,7 @@ typedef struct _FooWidget {
         <para>
           Use <code>/*&lt; private &gt;*/</code> before the private struct fields
           you want to hide. Use <code>/*&lt; public &gt;*/</code> for the reverse
-          behavirour.
+          behaviour.
         </para>
         
         <para>
@@ -1152,7 +1154,7 @@ typedef enum {
         <para>
           Use <code>/*&lt; private &gt;*/</code> before the private enum values
           you want to hide. Use <code>/*&lt; public &gt;*/</code> for the reverse
-          behavirour.
+          behaviour.
         </para>
 
       </sect2>
@@ -1398,7 +1400,7 @@ gtk_arrow_get_type
         GTK-Doc produces documentation in DocBook SGML/XML. When processing the
         inline source comments, the GTK-Doc tools generate one documentation
         page per class or module as a separate file. The master document
-        includes them and place them in a order.
+        includes them and place them in an order.
       </para>
 
       <para>
@@ -1560,7 +1562,7 @@ gtk_arrow_get_type
     <para>
       One can also look at the files produced by the source code scanner:
       <filename>&lt;package&gt;-decl-list.txt</filename> and
-      <filename>&lt;package&gt;-decl.txt</filename>. The first and can be
+      <filename>&lt;package&gt;-decl.txt</filename>. The first one can be
       compared with the section file if that is manualy maintained. The second
       lists all declarations fromt he headers If a symbol is missing one could
       check if this file contains it.
@@ -1670,7 +1672,7 @@ http://cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus)
   </chapter>
 
   <chapter id="faq">
-    <title>Frequently asked question</title>
+    <title>Frequently asked questions</title>
 
     <segmentedlist>
       <?dbhtml list-presentation="list"?>



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]