[gnome-devel-docs] programming-guidelines: Fix various broken links



commit 6c73ea087393f5f8259ee2754ff4ec8e452751c8
Author: Philip Withnall <philip withnall collabora co uk>
Date:   Wed Feb 18 16:05:44 2015 +0000

    programming-guidelines: Fix various broken links

 programming-guidelines/C/databases.page     |    9 ++++++++-
 programming-guidelines/C/documentation.page |   16 +++++++++++-----
 programming-guidelines/C/logging.page       |    3 +--
 programming-guidelines/C/main-contexts.page |    6 +++---
 programming-guidelines/C/preconditions.page |    2 +-
 5 files changed, 24 insertions(+), 12 deletions(-)
---
diff --git a/programming-guidelines/C/databases.page b/programming-guidelines/C/databases.page
index 9e95574..7ba9cec 100644
--- a/programming-guidelines/C/databases.page
+++ b/programming-guidelines/C/databases.page
@@ -89,10 +89,17 @@
 
     <p>
       Providing a GOM tutorial is beyond the scope of this document, but a
-      <link href="https://developer.gnome.org/gom/stable/";>reference manual is
+      <link href="https://developer.gnome.org/gom/0.2/";>reference manual is
       available</link>.
     </p>
 
+    <comment>
+      <p>
+        FIXME: Update this link to https://developer.gnome.org/gom/stable/ once
+        it’s available.
+      </p>
+    </comment>
+
     <section id="sql-injection">
       <title>SQL Injection</title>
 
diff --git a/programming-guidelines/C/documentation.page b/programming-guidelines/C/documentation.page
index c5f8897..805c810 100644
--- a/programming-guidelines/C/documentation.page
+++ b/programming-guidelines/C/documentation.page
@@ -67,11 +67,11 @@
 
     <p>
       The preferred documentation system for GNOME libraries is <link
-      xref="http://www.gtk.org/gtk-doc/";>gtk-doc</link>, which
+      href="http://www.gtk.org/gtk-doc/";>gtk-doc</link>, which
       extracts inline comments from the code to let you build a <link
-      xref="http://docbook.org/";>DocBook</link> document and collection of HTML
+      href="http://docbook.org/";>DocBook</link> document and collection of HTML
       pages.  These can then be read in
-      <link xref="https://wiki.gnome.org/Apps/Devhelp";>Devhelp</link>.  A lot of
+      <link href="https://wiki.gnome.org/Apps/Devhelp";>Devhelp</link>.  A lot of
       GNOME’s infrastructure is built to handle with documentation written using
       gtk-doc.
     </p>
@@ -338,10 +338,16 @@ gtk_get_flow (GtkWidget *widget)
     <p>
       D-Bus interface descriptions contain documentation comments, and these can
       be extracted from the XML using <cmd>gdbus-codegen</cmd>, and turned into
-      DocBook files to be included by gtk-doc. Generate the documentation using
-      the rules described in the <link xref="dbus">D-Bus guidelines</link>.
+      DocBook files to be included by gtk-doc.
     </p>
 
+    <comment>
+      <p>
+        FIXME: Create a page on D-Bus and link to it. Put automake rules to
+        generate the documentation somewhere.
+      </p>
+    </comment>
+
     <p>
       The DocBook files can be included in the main <file>*-docs.xml</file> file
       using:
diff --git a/programming-guidelines/C/logging.page b/programming-guidelines/C/logging.page
index 83ee488..39b81c1 100644
--- a/programming-guidelines/C/logging.page
+++ b/programming-guidelines/C/logging.page
@@ -174,8 +174,7 @@ g_log_set_handler ("log-domain",
         </p></item>
         <item><p>
           Do not use  <code>g_warning()</code> in library code. Use
-          <link xref="coding-conventions#gerror-usage"><code>GError</code>s</link>
-          instead.
+          <link xref="gerror"><code>GError</code>s</link> instead.
         </p></item>
         <item><p>
           Similarly, do not set up log handlers in library code. Log messages
diff --git a/programming-guidelines/C/main-contexts.page b/programming-guidelines/C/main-contexts.page
index a83e6c6..55e08b0 100644
--- a/programming-guidelines/C/main-contexts.page
+++ b/programming-guidelines/C/main-contexts.page
@@ -547,7 +547,7 @@ do_computation (gpointer user_data)
       <p>
         The core principle of invoking a function in a specific context is
         simple, and is walked through below to explain the concepts. In practice
-        the <link xref="g-main-context-invoke-full">convenience method,
+        the <link xref="#g-main-context-invoke-full">convenience method,
         <code>g_main_context_invoke_full()</code></link> should be used instead.
       </p>
 
@@ -564,7 +564,7 @@ do_computation (gpointer user_data)
 
       <p>
         The <code>GSource</code> will be
-        <link xref="what-is-gmaincontext">dispatched as soon as it’s ready</link>,
+        <link xref="#what-is-gmaincontext">dispatched as soon as it’s ready</link>,
         calling the function on the thread’s stack. In the case of an idle source,
         this will be as soon as all sources at a higher priority have been
         dispatched — this can be tweaked using the idle source’s priority
@@ -896,7 +896,7 @@ emit_some_signal (GObject     *my_object,
     <example>
       <p>
         By combining
-        <link xref="g-main-context-invoke-full"><code>g_main_context_invoke_full()</code></link>
+        <link xref="#g-main-context-invoke-full"><code>g_main_context_invoke_full()</code></link>
         and <code>GTask</code>, it is possible to run a task in a specific context
         and effortlessly return its result to the current context:
       </p>
diff --git a/programming-guidelines/C/preconditions.page b/programming-guidelines/C/preconditions.page
index 4b1e898..5239190 100644
--- a/programming-guidelines/C/preconditions.page
+++ b/programming-guidelines/C/preconditions.page
@@ -52,7 +52,7 @@
 
     <p>
       Validation is a complex topic, and is handled using
-      <link xref="gerrors">GErrors</link>. The remainder of this section
+      <link xref="gerror">GErrors</link>. The remainder of this section
       discusses pre- and post-condition assertions, which are purely for
       catching programmer errors. A programmer error is where a function is
       called in a way which is documented as disallowed. For example, if


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