Update warnings and add in additional new documentation.

Makefile.am

@@ -49,9 +49,14 @@ EXTRA_DIST+= \
 	scripts/README.solaris
 
 docs: all man
+	${DOXYGEN} docs/Doxyfile.api
+	${DOXYGEN} docs/Doxyfile.dev
 
 test: check
 
+clean-local:
+	-rm -rf docs/_build docs/doctrees
+
 rpm: all dist
 	cp gearmand-$(VERSION).tar.gz ~/rpmbuild/SOURCES/
 	rpmbuild -ba support/gearmand.spec

docs/conf.py

@@ -0,0 +1,223 @@
+# -*- coding: utf-8 -*-
+#
+# libmemcached documentation build configuration file, created by
+# sphinx-quickstart on Sun Mar  6 12:05:53 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'libmemcached'
+copyright = u'2011, Brian Aker'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.47'
+# The full version, including alpha/beta/rc tags.
+release = '0.47'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'libmemcacheddoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'libmemcached.tex', u'libmemcached Documentation',
+   u'Brian Aker', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+  ('gearman_client_st', 'gearman_client_st', u'Gearmand Documentation', [u'Data Differential'], 3),
+  ('gearman_client_execute', 'gearman_client_execute', u'Gearmand Documentation', [u'Data Differential'], 3),
+  ('gearman_client_st', 'gearman_client_st', u'Gearmand Documentation', [u'Data Differential'], 3),
+  ('gearman_function_st', 'gearman_function_st', u'Gearmand Documentation', [u'Data Differential'], 3),
+  ('gearman_job_st', 'gearman_job_st', u'Gearmand Documentation', [u'Data Differential'], 3),
+  ('gearman_state_t', 'gearman_state_t', u'Gearmand Documentation', [u'Data Differential'], 3),
+  ('gearman_task_st', 'gearman_task_st', u'Gearmand Documentation', [u'Data Differential'], 3),
+  ('gearman_unique_t', 'gearman_unique_t', u'Gearmand Documentation', [u'Data Differential'], 3),
+  ('gearman_worker_st', 'gearman_worker_st', u'Gearmand Documentation', [u'Data Differential'], 3),
+  ]

docs/gearman_client_execute.rst

@@ -0,0 +1,16 @@
+
+
+.. highlightlang:: c
+
+Executing a Client request
+--------------------------
+
+.. index:: object: gearman_client_execute
+
+gearman_client_execute() can be used to execute tasks against a gearman network.
+
+
+.. c:function:: gearman_status_t gearman_client_execute(gearman_client_st *client,
+                                        const gearman_function_st *function,
+                                        gearman_unique_t *unique,
+                                        const gearman_workload_t *workload);

docs/gearman_function_st.rst

@@ -0,0 +1,16 @@
+
+
+.. highlightlang:: c
+
+Using Functions
+---------------
+
+.. index:: object: gearman_function_st
+
+This a complete list of all functions that work with a gearman_function_st,
+see their individual pages to learn more about them. gearman_function_st must be decallocated when you finish with them.
+
+
+.. c:function:: gearman_function_st *gearman_function_create(const char *, size_t size);
+
+.. c:function:: void gearman_function_free(gearman_function_st *);

docs/gearman_job_st.rst

@@ -0,0 +1,47 @@
+
+
+.. highlightlang:: c
+
+Job Functions
+-------------
+
+.. index:: object: gearman_job_st
+
+This a complete list of all functions that work with a gearman_job_st,
+see their individual pages to learn more about them.
+
+
+void gearman_job_free(gearman_job_st *job);
+
+.. c:function:: gearman_return_t gearman_job_send_data(gearman_job_st *job, const void *data,
+                                       size_t data_size);
+
+.. c:function:: gearman_return_t gearman_job_send_warning(gearman_job_st *job,
+                                          const void *warning,
+                                          size_t warning_size);
+
+.. c:function:: gearman_return_t gearman_job_send_status(gearman_job_st *job,
+                                         uint32_t numerator,
+                                         uint32_t denominator);
+
+.. c:function:: gearman_return_t gearman_job_send_complete(gearman_job_st *job,
+                                           const void *result,
+                                           size_t result_size);
+
+.. c:function:: gearman_return_t gearman_job_send_exception(gearman_job_st *job,
+                                            const void *exception,
+                                            size_t exception_size);
+
+.. c:function:: gearman_return_t gearman_job_send_fail(gearman_job_st *job);
+
+.. c:function:: const char *gearman_job_handle(const gearman_job_st *job);
+
+.. c:function:: const char *gearman_job_function_name(const gearman_job_st *job);
+
+.. c:function:: const char *gearman_job_unique(const gearman_job_st *job);
+
+.. c:function:: const void *gearman_job_workload(const gearman_job_st *job);
+
+.. c:function:: size_t gearman_job_workload_size(const gearman_job_st *job);
+
+.. c:function:: void *gearman_job_take_workload(gearman_job_st *job, size_t *data_size);

docs/gearman_state_t.rst

@@ -0,0 +1,19 @@
+
+
+.. highlightlang:: c
+
+Client Functions
+----------------
+
+.. index:: object: gearman_status_t
+
+gearman_status_t requires no allocation or deallocation.
+
+This a complete list of all functions that work with a gearman_status_t,
+see their individual pages to learn more about them.
+
+
+.. c:function:: bool gearman_status_is_successful(const gearman_status_t);
+
+.. c:function:: gearman_task_st *gearman_status_task(const gearman_status_t);
+

docs/gearman_unique_t.rst

@@ -0,0 +1,17 @@
+
+
+.. highlightlang:: c
+
+Creating a unique handle 
+------------------------
+
+.. index:: object: gearman_unique_t
+
+gearman_unique_t requires no allocation or deallocation. gearman_unique_t is used with gearman_client_execute().
+
+This a complete list of all functions that work with a gearman_unique_t,
+see their individual pages to learn more about them. 
+
+
+.. c:function:: gearman_unique_t gearman_unique_make(const char *arg, size_t arg_size);
+

docs/include.am

@@ -3,7 +3,16 @@
 # All paths should be given relative to the root
 
 EXTRA_DIST+= \
-	     docs/conf.py
+	     docs/conf.py \
+	     docs/gearman_client_execute.rst \
+	     docs/gearman_client_st.rst \
+	     docs/gearman_function_st.rst \
+	     docs/gearman_job_st.rst \
+	     docs/gearman_state_t.rst \
+	     docs/gearman_task_st.rst \
+	     docs/gearman_unique_t.rst \
+	     docs/gearman_worker_st.rst
+
 
 # Makefile for Sphinx documentation
 #
@@ -19,16 +28,34 @@ ALLSPHINXOPTS   = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOP
 
 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
 
+include docs/man_list
+
 if HAVE_RECENT_SPHINX
 
 man_MANS+= \
-	   docs/man/gearman_client_st.1
+	   docs/man/gearman_client_execute.3 \
+	   docs/man/gearman_client_st.3 \
+	   docs/man/gearman_function_st.3 \
+	   docs/man/gearman_job_st.3 \
+	   docs/man/gearman_state_t.3 \
+	   docs/man/gearman_task_st.3 \
+	   docs/man/gearman_unique_t.3 \
+	   docs/man/gearman_worker_st.3
 
 DISTCLEANFILES+= \
 		 docs/man/*
+		 docs/man/1/*
+		 docs/man/3/*
+
+docs/man/gearman_client_execute.3: man
+docs/man/gearman_client_st.3: man
+docs/man/gearman_function_st.3: man
+docs/man/gearman_job_st.3: man
+docs/man/gearman_state_t.3: man
+docs/man/gearman_task_st.3: man
+docs/man/gearman_unique_t.3: man
+docs/man/gearman_worker_st.3: man
 
-docs/man/gearman_client_st.1: man
- 
 endif
 
 if HAVE_SPHINX

docs/index.rst

@@ -26,6 +26,12 @@ C/C++ Client Library:
    gearman_client_st 
    gearman_task_st
    gearman_worker_st
+   gearman_job_st
+   gearman_client_execute
+   gearman_function_st
+   gearman_state_t
+   gearman_unique_t
+
 
 Indices and tables
 ==================

libgearman/status.cc

@@ -43,6 +43,12 @@ gearman_status_t gearman_failure()
   return status;
 }
 
+gearman_status_t gearman_success()
+{
+  static gearman_status_t status= { false, 0 };
+  return status;
+}
+
 bool gearman_status_is_successful(const gearman_status_t self)
 {
   return self.successful;