beagle r4631 - in trunk/libbeagle: beagle docs/reference docs/reference/tmpl
- From: dbera svn gnome org
- To: svn-commits-list gnome org
- Subject: beagle r4631 - in trunk/libbeagle: beagle docs/reference docs/reference/tmpl
- Date: Sat, 22 Mar 2008 01:08:54 +0000 (GMT)
Author: dbera
Date: Sat Mar 22 01:08:53 2008
New Revision: 4631
URL: http://svn.gnome.org/viewvc/beagle?rev=4631&view=rev
Log:
Uptodate the documentation.
Modified:
trunk/libbeagle/beagle/beagle-queryable-status.c
trunk/libbeagle/docs/reference/Makefile.am
trunk/libbeagle/docs/reference/beagle-sections.txt
trunk/libbeagle/docs/reference/tmpl/beagle-hit.sgml
trunk/libbeagle/docs/reference/tmpl/beagle-query.sgml
trunk/libbeagle/docs/reference/tmpl/beagle-snippet-request.sgml
trunk/libbeagle/docs/reference/tmpl/beagle-timestamp.sgml
trunk/libbeagle/docs/reference/tmpl/beagle-unused.sgml
Modified: trunk/libbeagle/beagle/beagle-queryable-status.c
==============================================================================
--- trunk/libbeagle/beagle/beagle-queryable-status.c (original)
+++ trunk/libbeagle/beagle/beagle-queryable-status.c Sat Mar 22 01:08:53 2008
@@ -120,7 +120,7 @@
* beagle_queryable_status_get_state:
* @status: a #BeagleQueryableStatus
*
- * DEPRECATED: This function will be removed in a future version. At
+ * @DEPRECATED: This function is obsolete since 0.2.0. At
* present, this function will always reutrn BEAGLE_QUERYABLE_STATE_NA.
*
* Return value: BEAGLE_QUERYABLE_STATE_NA.
@@ -128,9 +128,7 @@
BeagleQueryableState
beagle_queryable_status_get_state (BeagleQueryableStatus *status)
{
- g_return_val_if_fail (status != NULL, BEAGLE_QUERYABLE_STATE_NA);
-
- return status->state;
+ return BEAGLE_QUERYABLE_STATE_NA;
}
/**
Modified: trunk/libbeagle/docs/reference/Makefile.am
==============================================================================
--- trunk/libbeagle/docs/reference/Makefile.am (original)
+++ trunk/libbeagle/docs/reference/Makefile.am Sat Mar 22 01:08:53 2008
@@ -25,7 +25,7 @@
# Extra options to supply to gtkdoc-scan.
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=
+SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
# Extra options to supply to gtkdoc-mkdb.
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
Modified: trunk/libbeagle/docs/reference/beagle-sections.txt
==============================================================================
--- trunk/libbeagle/docs/reference/beagle-sections.txt (original)
+++ trunk/libbeagle/docs/reference/beagle-sections.txt Sat Mar 22 01:08:53 2008
@@ -195,9 +195,6 @@
beagle_query_new
beagle_query_add_part
beagle_query_add_text
-beagle_query_add_mime_type
-beagle_query_add_hit_type
-beagle_query_add_source
beagle_query_set_domain
beagle_query_add_domain
beagle_query_remove_domain
@@ -423,6 +420,9 @@
beagle_snippet_request_new
beagle_snippet_request_set_hit
beagle_snippet_request_set_query
+beagle_snippet_request_set_context_length
+beagle_snippet_request_set_full_text
+beagle_snippet_request_set_snippet_length
<SUBSECTION Standard>
BEAGLE_SNIPPET_REQUEST
BEAGLE_IS_SNIPPET_REQUEST
@@ -485,6 +485,7 @@
beagle_hit_get_uri
beagle_hit_get_type
beagle_hit_get_mime_type
+beagle_hit_get_file_type
beagle_hit_get_source
beagle_hit_get_parent_uri
beagle_hit_get_timestamp
Modified: trunk/libbeagle/docs/reference/tmpl/beagle-hit.sgml
==============================================================================
--- trunk/libbeagle/docs/reference/tmpl/beagle-hit.sgml (original)
+++ trunk/libbeagle/docs/reference/tmpl/beagle-hit.sgml Sat Mar 22 01:08:53 2008
@@ -75,6 +75,15 @@
@Returns:
+<!-- ##### FUNCTION beagle_hit_get_file_type ##### -->
+<para>
+
+</para>
+
+ hit:
+ Returns:
+
+
<!-- ##### FUNCTION beagle_hit_get_source ##### -->
<para>
Modified: trunk/libbeagle/docs/reference/tmpl/beagle-query.sgml
==============================================================================
--- trunk/libbeagle/docs/reference/tmpl/beagle-query.sgml (original)
+++ trunk/libbeagle/docs/reference/tmpl/beagle-query.sgml Sat Mar 22 01:08:53 2008
@@ -83,33 +83,6 @@
@str:
-<!-- ##### FUNCTION beagle_query_add_mime_type ##### -->
-<para>
-
-</para>
-
- query:
- mime_type:
-
-
-<!-- ##### FUNCTION beagle_query_add_hit_type ##### -->
-<para>
-
-</para>
-
- query:
- hit_type:
-
-
-<!-- ##### FUNCTION beagle_query_add_source ##### -->
-<para>
-
-</para>
-
- query:
- source:
-
-
<!-- ##### FUNCTION beagle_query_set_domain ##### -->
<para>
Modified: trunk/libbeagle/docs/reference/tmpl/beagle-snippet-request.sgml
==============================================================================
--- trunk/libbeagle/docs/reference/tmpl/beagle-snippet-request.sgml (original)
+++ trunk/libbeagle/docs/reference/tmpl/beagle-snippet-request.sgml Sat Mar 22 01:08:53 2008
@@ -49,3 +49,30 @@
@query:
+<!-- ##### FUNCTION beagle_snippet_request_set_context_length ##### -->
+<para>
+
+</para>
+
+ request:
+ ctx_length:
+
+
+<!-- ##### FUNCTION beagle_snippet_request_set_full_text ##### -->
+<para>
+
+</para>
+
+ request:
+ full_text:
+
+
+<!-- ##### FUNCTION beagle_snippet_request_set_snippet_length ##### -->
+<para>
+
+</para>
+
+ request:
+ snp_length:
+
+
Modified: trunk/libbeagle/docs/reference/tmpl/beagle-timestamp.sgml
==============================================================================
--- trunk/libbeagle/docs/reference/tmpl/beagle-timestamp.sgml (original)
+++ trunk/libbeagle/docs/reference/tmpl/beagle-timestamp.sgml Sat Mar 22 01:08:53 2008
@@ -9,13 +9,11 @@
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### SECTION Stability_Level ##### -->
Modified: trunk/libbeagle/docs/reference/tmpl/beagle-unused.sgml
==============================================================================
--- trunk/libbeagle/docs/reference/tmpl/beagle-unused.sgml (original)
+++ trunk/libbeagle/docs/reference/tmpl/beagle-unused.sgml Sat Mar 22 01:08:53 2008
@@ -0,0 +1,24 @@
+<!-- ##### FUNCTION beagle_query_add_hit_type ##### -->
+<para>
+
+</para>
+
+ query:
+ hit_type:
+
+<!-- ##### FUNCTION beagle_query_add_mime_type ##### -->
+<para>
+
+</para>
+
+ query:
+ mime_type:
+
+<!-- ##### FUNCTION beagle_query_add_source ##### -->
+<para>
+
+</para>
+
+ query:
+ source:
+
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]