cleanup copyright headers and some doc comments

desktop/gui.h

@@ -1,6 +1,5 @@
 /*
- * Copyright 2003 Phil Mellor <monkeyson@users.sourceforge.net>
- * Copyright 2004 James Bursa <bursa@users.sourceforge.net>
+ * Copyright 2014 Vincent Sanders <vince@netsurf-browser.org>
  *
  * This file is part of NetSurf, http://www.netsurf-browser.org/
  *
@@ -26,14 +25,8 @@
 
 #include <stdbool.h>
 
-#include <libwapcaplet/libwapcaplet.h>
-#include <libcss/libcss.h>
-
-#include "utils/config.h"
 #include "content/hlcache.h"
 #include "desktop/download.h"
-#include "desktop/mouse.h"
-#include "desktop/search.h"
 #include "utils/errors.h"
 
 typedef enum {

desktop/gui_factory.c

@@ -1,12 +1,29 @@
+/*
+ * Copyright 2014 Vincent Sanders <vince@netsurf-browser.org>
+ *
+ * This file is part of NetSurf, http://www.netsurf-browser.org/
+ *
+ * NetSurf is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * NetSurf is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
 
 #include "desktop/gui.h"
 #include "desktop/gui_factory.h"
 
+/** The global GUI interface table */
 struct gui_table *guit = NULL;
 
 
 
-
 static void gui_default_window_set_title(struct gui_window *g, const char *title)
 {
 }
@@ -254,6 +271,7 @@ static void gui_default_set_clipboard(const char *buffer, size_t length,
 {
 }
 
+/** verify clipboard table is valid */
 static nserror verify_clipboard_register(struct gui_clipboard_table *gct)
 {
 	/* check table is present */
@@ -310,7 +328,7 @@ static void gui_default_401login_open(nsurl *url, const char *realm,
 	cb(false, cbpw);
 }
 
-
+/** verify browser table is valid */
 static nserror verify_browser_register(struct gui_browser_table *gbt)
 {
 	/* check table is present */
@@ -369,6 +387,7 @@ static struct gui_clipboard_table default_clipboard_table = {
 	.set = gui_default_set_clipboard,
 };
 
+/* exported interface documented in desktop/gui_factory.h */
 nserror gui_factory_register(struct gui_table *gt)
 {
 	nserror err;

desktop/gui_factory.h

@@ -25,8 +25,15 @@
 
 #include "desktop/gui.h"
 
-extern struct gui_table *guit; /* the gui vtable */
+/** The global operation table */
+extern struct gui_table *guit;
 
+/** register and verify global operation table
+ *
+ * @param gt The global table to register
+ * @return NSERROR_OK on success or error code on faliure. On faliure
+ * global table will not be initialised
+ */
 nserror gui_factory_register(struct gui_table *gt);
 
 #endif

framebuffer/gui.c

@@ -1826,10 +1826,11 @@ static struct gui_window_table framebuffer_window_table = {
 
 static struct gui_browser_table framebuffer_browser_table = {
 	.poll = gui_poll,
-	.quit = gui_quit,
-	.get_resource_url = gui_get_resource_url,
 	.filename_from_path = filename_from_path,
 	.path_add_part = path_add_part,
+
+	.quit = gui_quit,
+	.get_resource_url = gui_get_resource_url,
 };
 
 /** Entry point from OS.

riscos/query.h

@@ -29,4 +29,8 @@ query_id query_user_xy(const char *query, const char *detail,
 void ro_gui_query_init(void);
 void ro_gui_query_window_bring_to_front(query_id id);
 
+query_id query_user(const char *query, const char *detail,
+	const query_callback *cb, void *pw, const char *yes, const char *no);
+void query_close(query_id);
+
 #endif

utils/utils.h

@@ -186,9 +186,4 @@ void die(const char * const error);
 void warn_user(const char *warning, const char *detail);
 void PDF_Password(char **owner_pass, char **user_pass, char *path);
 
-/* only riscos */
-query_id query_user(const char *query, const char *detail,
-	const query_callback *cb, void *pw, const char *yes, const char *no);
-void query_close(query_id);
-
 #endif