summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRicardo Wurmus <rekado@elephly.net>2017-11-18 11:09:31 +0100
committerRicardo Wurmus <rekado@elephly.net>2017-11-18 11:09:31 +0100
commit43aae141d39fb7d8855322995f69d513ee098300 (patch)
tree53a584565d8fc18ff8d33cd97df5e58ae93d8968 /doc
parentf473bc14446051352f394f6ad50619fb03a7eccc (diff)
doc: Summarize included modules.
* doc/guile-debbugs.texi (Introduction): List and describe all modules.
Diffstat (limited to 'doc')
-rw-r--r--doc/guile-debbugs.texi26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/guile-debbugs.texi b/doc/guile-debbugs.texi
index 5de5ebb..d617d95 100644
--- a/doc/guile-debbugs.texi
+++ b/doc/guile-debbugs.texi
@@ -118,6 +118,32 @@ service, and it defines operations that can be invoked on it. It does
not provide a full implementation of SOAP and it has only been tested
with Debbugs.
+The following modules are included:
+
+@table @code
+@item (debbugs base64)
+Procedures for decoding and encoding base64 strings.
+
+@item (debbugs bug)
+Procedures to parse bugs as returned by Debbugs, and to access their
+properties.
+
+@item (debbugs email)
+Procedures to parse emails as returned by Debbugs.
+
+@item (debbugs operations)
+Implementations of SOAP operations supported by Debbugs.
+
+@item (debbugs rfc822)
+Parser for email headers.
+
+@item (debbugs soap)
+Procedures for talking with SOAP services.
+@end table
+
+The modules @code{(debbugs rfc822)} and @code{(debbugs base64)} won't be
+documented here as they are primarily for internal use.
+
@menu
* SOAP helpers:: Procedures for talking with SOAP services.
* Operations:: Debbugs SOAP operations.