Merge lp:~zorba-coders/zorba/email_doc into lp:zorba/email-module

[William Candillon]

Minor documentation improvements.

[William Candillon (wcandillon)]

review: Approve

[Sorin Marian Nasoi (sorin.marian.nasoi)]

William please set the Library tag back.
It is used in the module dependency graph to see external module dependencies.

review: Needs Fixing

[William Candillon (wcandillon)]

review: Approve

[William Candillon (wcandillon)]

Nice catch. It's back.

[Sorin Marian Nasoi (sorin.marian.nasoi)]

Please note that these changes require the new XQDoc generator to be merged into the trunk first.

review: Approve

=== modified file 'src/com/zorba-xquery/www/modules/email/imap.xq'
--- src/com/zorba-xquery/www/modules/email/imap.xq	2012-04-11 09:50:26 +0000
+++ src/com/zorba-xquery/www/modules/email/imap.xq	2012-09-28 12:14:25 +0000
@@ -25,21 +25,22 @@
  : in the email schema: <code>http://www.zorba-xquery.com/modules/email</code>.
  :
  : For example:
- : <pre>
- : &lt;email:hostInfo&gt;
- :   &lt;email:hostName&gt;imap.example.com&lt;/email:hostName&gt;
- :   &lt;email:userName&gt;myuser&lt;/email:userName&gt;
- :   &lt;email:password&gt;mypassword&lt;/email:password&gt;
- : &lt;/email:hostInfo&gt;
- : </pre>
+ : <pre class="ace-static" ace-mode="xquery"><![CDATA[
+ : <email:hostInfo>
+ :   <email:hostName>imap.example.com</email:hostName>
+ :   <email:userName>myuser</email:userName>
+ :   <email:password>mypassword</email:password>
+ : </email:hostInfo>
+ : ]]></pre>
  :
  : The <code>hostInfoType</code> only needs to be in the email schema namespace
  : (<code>http://www.zorba-xquery.com/modules/email</code>). It does not need
  : to be validated since it's validated by the module.
  :
  : @author Daniel Thomas, Gabriel Petrovay
+ : @see <a href="http://www.washington.edu/imap/">c-client library part of UW IMAP toolkit</a>
  : @library <a href="http://www.washington.edu/imap/">c-client library part of UW IMAP toolkit</a>
- : @project communication
+ : @project Zorba/IO/IMAP
  :)
 module namespace imap = 'http://www.zorba-xquery.com/modules/email/imap';
 

=== modified file 'src/com/zorba-xquery/www/modules/email/smtp.xq'
--- src/com/zorba-xquery/www/modules/email/smtp.xq	2012-04-11 09:50:26 +0000
+++ src/com/zorba-xquery/www/modules/email/smtp.xq	2012-09-28 12:14:25 +0000
@@ -27,8 +27,9 @@
  : documentation associated with this function.
  :
  : @author Sorin Nasoi, Daniel Thomas
+ : @see <a href="http://www.washington.edu/imap/">c-client Library part of UW IMAP toolkit</a>
  : @library <a href="http://www.washington.edu/imap/">c-client Library part of UW IMAP toolkit</a>
- : @project communication
+ : @project Zorba/IO/SMTP
  :)
 module namespace smtp = "http://www.zorba-xquery.com/modules/email/smtp";
 
@@ -55,13 +56,13 @@
  : </ul>
  :
  : The <code>$host-info</code> parameter could then look like this:
- : <pre>
- : &lt;hostInfo&gt;
- : &lt;hostName&gt;smtp.gmail.com:587/tls/novalidate-cert&lt;hostName&gt;
- : &lt;userName&gt;username&lt;userName&gt;
- : &lt;password&gt;password&lt;password&gt;
- : &lt;/hostInfo&gt;
- : </pre>
+ : <pre class="ace-static" ace-mode="xquery"><![CDATA[
+ : <hostInfo>
+ :   <hostName>smtp.gmail.com:587/tls/novalidate-cert</hostName>
+ :   <userName>username</userName>
+ :   <password>password</password>
+ : </hostInfo>
+ : ]]></pre>
  :
  : For a complete of the structure of an email message, see the imported email
  : schema: <code>http://www.zorba-xquery.com/modules/email</code>