[Gurlchecker-commits] r699 - in trunk: . doc doc/tmpl po src

esaracco at users.labs.libre-entreprise.org esaracco at users.labs.libre-entreprise.org
Thu Jan 14 22:14:55 CET 2010


Author: esaracco
Date: 2010-01-14 21:14:54 +0000 (Thu, 14 Jan 2010)
New Revision: 699

Added:
   trunk/doc/tmpl/cookies.sgml
Modified:
   trunk/ChangeLog
   trunk/doc/gurlchecker-sections.txt
   trunk/doc/tmpl/application.sgml
   trunk/doc/tmpl/general.sgml
   trunk/doc/tmpl/lists.sgml
   trunk/doc/tmpl/project.sgml
   trunk/po/fr.po
   trunk/src/application.c
   trunk/src/bookmarks.c
   trunk/src/general.h
   trunk/src/project.c
   trunk/src/report.c
   trunk/src/utils.c
   trunk/src/utils.h
Log:
Some work on code documentation.


Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/ChangeLog	2010-01-14 21:14:54 UTC (rev 699)
@@ -12,6 +12,10 @@
 
 	  - Added "aspx" extension.
 
+	* Documentation:
+
+	  - Some work on code documentation.
+
 2010-01-13 Emmanuel Saracco <esaracco at users.labs.libre-entreprise.org>
 
 	* Export:

Modified: trunk/doc/gurlchecker-sections.txt
===================================================================
--- trunk/doc/gurlchecker-sections.txt	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/doc/gurlchecker-sections.txt	2010-01-14 21:14:54 UTC (rev 699)
@@ -1,5 +1,9 @@
 <SECTION>
+uc_application_get_urls_user_action
+uc_application_get_urls_user_action_by_value
+uc_application_urls_user_actions_init
 <FILE>general</FILE>
+UC_BUFFER_DATETIME_LEN
 UC_ARRAY_SIZE
 UC_SYSTEM_NAME
 UC_VERSION
@@ -114,8 +118,6 @@
 UCStatusCode
 UCHTMLTag
 UCLinkProperties
-GHashNode
-GHashTable
 UC_WWW_AUTHENTICATE
 <SUBSECTION Standard>
 UC_STATUS_CODE_HOST_IS_UNREACHABLE
@@ -311,6 +313,10 @@
 
 <SECTION>
 <FILE>application</FILE>
+UCURLsUserActions
+uc_application_get_urls_user_action
+uc_application_get_urls_user_action_by_value
+uc_application_urls_user_actions_init
 uc_application_cookie_warning_dialog_show
 uc_application_w3c_validate
 uc_application_buffer_show
@@ -376,6 +382,13 @@
 </SECTION>
 
 <SECTION>
+<FILE>cookies</FILE>
+uc_cookies_add
+uc_cookies_free
+uc_cookies_get_header_field
+</SECTION>
+
+<SECTION>
 <FILE>report</FILE>
 uc_report_export
 uc_check_report_force_values
@@ -404,6 +417,7 @@
 
 <SECTION>
 <FILE>lists</FILE>
+uc_lists_checked_links_dump
 uc_lists_refresh_preserved_links_reset
 uc_lists_bad_extensions_append
 uc_lists_refresh_preserved_links_append
@@ -458,6 +472,8 @@
 <SECTION>
 <FILE>project</FILE>
 UCProjectType
+uc_project_get_cookies
+uc_project_set_cookies
 uc_project_report_save
 uc_project_get_check_is_main
 uc_project_set_check_is_main
@@ -492,9 +508,7 @@
 uc_project_get_cookies_warn_deleted
 uc_project_set_cookies_warn_deleted
 uc_project_get_cookies_accept
-uc_project_cookies_add
 uc_project_set_cookies_accept
-uc_project_cookies_get_header_field
 uc_project_xml_load_settings
 uc_project_general_settings_save
 uc_project_save_index

Modified: trunk/doc/tmpl/application.sgml
===================================================================
--- trunk/doc/tmpl/application.sgml	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/doc/tmpl/application.sgml	2010-01-14 21:14:54 UTC (rev 699)
@@ -17,6 +17,39 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
+<!-- ##### STRUCT UCURLsUserActions ##### -->
+<para>
+
+</para>
+
+ at id: 
+ at label: 
+
+<!-- ##### FUNCTION uc_application_get_urls_user_action ##### -->
+<para>
+
+</para>
+
+ at key: 
+ at Returns: 
+
+
+<!-- ##### FUNCTION uc_application_get_urls_user_action_by_value ##### -->
+<para>
+
+</para>
+
+ at value: 
+ at Returns: 
+
+
+<!-- ##### FUNCTION uc_application_urls_user_actions_init ##### -->
+<para>
+
+</para>
+
+
+
 <!-- ##### FUNCTION uc_application_cookie_warning_dialog_show ##### -->
 <para>
 
@@ -29,7 +62,7 @@
 @value: 
 @path: 
 @expires: 
- at Param8: 
+ at action: 
 @Returns: 
 
 

Added: trunk/doc/tmpl/cookies.sgml
===================================================================
--- trunk/doc/tmpl/cookies.sgml	                        (rev 0)
+++ trunk/doc/tmpl/cookies.sgml	2010-01-14 21:14:54 UTC (rev 699)
@@ -0,0 +1,44 @@
+<!-- ##### SECTION Title ##### -->
+cookies
+
+<!-- ##### SECTION Short_Description ##### -->
+Manage some common cookies actions
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION uc_cookies_add ##### -->
+<para>
+
+</para>
+
+ at prop: 
+ at cook: 
+
+
+<!-- ##### FUNCTION uc_cookies_free ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION uc_cookies_get_header_field ##### -->
+<para>
+
+</para>
+
+ at path: 
+ at Returns: 
+
+

Modified: trunk/doc/tmpl/general.sgml
===================================================================
--- trunk/doc/tmpl/general.sgml	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/doc/tmpl/general.sgml	2010-01-14 21:14:54 UTC (rev 699)
@@ -17,6 +17,38 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
+<!-- ##### FUNCTION uc_application_get_urls_user_action ##### -->
+<para>
+
+</para>
+
+ at key: 
+ at Returns: 
+
+
+<!-- ##### FUNCTION uc_application_get_urls_user_action_by_value ##### -->
+<para>
+
+</para>
+
+ at value: 
+ at Returns: 
+
+
+<!-- ##### FUNCTION uc_application_urls_user_actions_init ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO UC_BUFFER_DATETIME_LEN ##### -->
+<para>
+
+</para>
+
+
+
 <!-- ##### MACRO UC_ARRAY_SIZE ##### -->
 <para>
 

Modified: trunk/doc/tmpl/lists.sgml
===================================================================
--- trunk/doc/tmpl/lists.sgml	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/doc/tmpl/lists.sgml	2010-01-14 21:14:54 UTC (rev 699)
@@ -17,6 +17,15 @@
 <!-- ##### SECTION Stability_Level ##### -->
 
 
+<!-- ##### FUNCTION uc_lists_checked_links_dump ##### -->
+<para>
+
+</para>
+
+ at list: 
+ at fd: 
+
+
 <!-- ##### FUNCTION uc_lists_refresh_preserved_links_reset ##### -->
 <para>
 

Modified: trunk/doc/tmpl/project.sgml
===================================================================
--- trunk/doc/tmpl/project.sgml	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/doc/tmpl/project.sgml	2010-01-14 21:14:54 UTC (rev 699)
@@ -28,6 +28,22 @@
 @UC_PROJECT_TYPE_ALL: 
 @UC_PROJECT_TYPES_LEN: 
 
+<!-- ##### FUNCTION uc_project_get_cookies ##### -->
+<para>
+
+</para>
+
+ at Returns: 
+
+
+<!-- ##### FUNCTION uc_project_set_cookies ##### -->
+<para>
+
+</para>
+
+ at value: 
+
+
 <!-- ##### FUNCTION uc_project_report_save ##### -->
 <para>
 

Modified: trunk/po/fr.po
===================================================================
--- trunk/po/fr.po	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/po/fr.po	2010-01-14 21:14:54 UTC (rev 699)
@@ -1,10 +1,10 @@
 # translation of fr.po to French
 # gURLChecker fr.po
-# Copyright (C) 2002-2009 Emmanuel Saracco <esaracco at users.labs.libre-entreprise.org>.
+# Copyright (C) 2002-2010 Emmanuel Saracco <esaracco at users.labs.libre-entreprise.org>.
 # This file is distributed under the same license as the gURLChecker package.
 #
 #
-# Emmanuel Saracco <esaracco at users.labs.libre-entreprise.org>, 2002-2005, 2009, 2010.
+# Emmanuel Saracco <esaracco at users.labs.libre-entreprise.org>, 2002-2010.
 msgid ""
 msgstr ""
 "Project-Id-Version: 0.11.2\n"

Modified: trunk/src/application.c
===================================================================
--- trunk/src/application.c	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/src/application.c	2010-01-14 21:14:54 UTC (rev 699)
@@ -723,11 +723,11 @@
  * @value: cookie's value.
  * @path: cookie's path.
  * @expires: expirationdate.
+ * @action: cookies action.
  *
  * Dialog for accepting/refusing a cookie.
  *
- * Returns: TRUE if the cookie must be accepted.
- *
+ * Returns: %TRUE if the cookie must be accepted.
  */
 gboolean
 uc_application_cookie_warning_dialog_show (const gchar * server,
@@ -1415,7 +1415,7 @@
 
 /**
  * uc_application_buttons_get_list:
- * @widget: 
+ * @widget: A GtkWidget
  * 
  * FIXME
  * Return a GList of pointers to the check buttons
@@ -4000,11 +4000,11 @@
 
 /**
  * uc_application_get_urls_user_action_by_value:
- * @id: action id.
+ * @value: user action value.
  * 
- * Return action for a given value.
+ * Get a action by its value.
  *
- * Returns: #UCURLsUserActions action node associated with the given value.
+ * Returns: A #UCURLsUserActions action node associated with the given value.
  */
 UCURLsUserActions *
 uc_application_get_urls_user_action_by_value (gchar * value)
@@ -4036,11 +4036,11 @@
 
 /**
  * uc_application_get_urls_user_action:
- * @id: action id.
+ * @key: user action key.
  * 
- * Return action for a given id.
+ * Get a action by its key.
  *
- * Returns: #UCURLsUserActions action node associated with the given id.
+ * Returns: A #UCURLsUserActions action node associated with the given id.
  */
 UCURLsUserActions *
 uc_application_get_urls_user_action (gchar * key)
@@ -4096,6 +4096,8 @@
  * uc_application_quit:
  * 
  * Do a clean application exit.
+ *
+ * returns: ~TRUE if we must quit application.
  */
 gboolean
 uc_application_quit (void)
@@ -4195,6 +4197,7 @@
  * @url: the command line URL, or %NULL
  * @auth_user: user for authentication.
  * @auth_password: password for authentication.
+ * @no_urls_args: if %TRUE, do not check URL with arguments
  * 
  * gURLChecker initialization.
  */

Modified: trunk/src/bookmarks.c
===================================================================
--- trunk/src/bookmarks.c	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/src/bookmarks.c	2010-01-14 21:14:54 UTC (rev 699)
@@ -48,6 +48,8 @@
  * uc_bookmarks_save_changes:
  *
  * Save bookmarks changes.
+ *
+ * Returns: %TRUE if the save must be done.
  */
 gint
 uc_bookmarks_save_changes (void)

Modified: trunk/src/general.h
===================================================================
--- trunk/src/general.h	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/src/general.h	2010-01-14 21:14:54 UTC (rev 699)
@@ -1196,6 +1196,10 @@
  * @bad_extensions: #GList of bad extensions that exists on the server for 
  *                  this node.
  * @tags: #GList of #UCHTMLTag for all links in this page.
+ * @user_action: A user defined action label
+ * @virii: if the file is a virus or not 
+ * @virname: Name of the virus is @virii == %TRUE
+ * @w3c_valid: %TRUE if the document is in a correct format
  * 
  * Structure to store links properties.
  */

Modified: trunk/src/project.c
===================================================================
--- trunk/src/project.c	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/src/project.c	2010-01-14 21:14:54 UTC (rev 699)
@@ -1331,6 +1331,8 @@
  *
  * Save the entire current project (settings, links etc.) in XML format
  * on the disk.
+ *
+ * Returns: %TRUE if project must be saved.
  */
 gint
 uc_project_save (void)

Modified: trunk/src/report.c
===================================================================
--- trunk/src/report.c	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/src/report.c	2010-01-14 21:14:54 UTC (rev 699)
@@ -123,6 +123,7 @@
 
 /**
  * uc_report_export:
+ * @format: export format.
  *
  * Export check report in the given format.
  */

Modified: trunk/src/utils.c
===================================================================
--- trunk/src/utils.c	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/src/utils.c	2010-01-14 21:14:54 UTC (rev 699)
@@ -388,6 +388,8 @@
 /**
  * uc_utils_get_auth_fields:
  * @g: a #GladeXML object.
+ * @w_auth_user: GtkWidget containing auth user string 
+ * @w_auth_password: GtkWidget containing auth password string 
  * @auth_user: user will be store here.
  * @auth_password: password will be store here.
  * @auth_line: authentication line will be store here.
@@ -437,8 +439,8 @@
 
 /**
  * uc_utils_build_auth_line:
- * @auth_user:
- * @auth_password:
+ * @auth_user: user
+ * @auth_password: password
  *
  * Build the line for basic authentication to pass to HTTP headers.
  * 

Modified: trunk/src/utils.h
===================================================================
--- trunk/src/utils.h	2010-01-14 20:25:03 UTC (rev 698)
+++ trunk/src/utils.h	2010-01-14 21:14:54 UTC (rev 699)
@@ -23,7 +23,6 @@
 
 #include "general.h"
 
-void uc_utils_all_links_export_csv (void);
 void uc_utils_clear_container (GtkContainer * container);
 void uc_utils_swap_file_proto_option (const gboolean begin);
 time_t uc_utils_http_atotm (const gchar * time_string);



More information about the Gurlchecker-commits mailing list