[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Xen-API] [PATCH 3 of 3] [ocamldoc] Intro text on first page of documentation


  • To: xen-api@xxxxxxxxxxxxxxxxxxx
  • From: Rob Hoes <rob.hoes@xxxxxxxxxx>
  • Date: Wed, 4 Nov 2009 10:25:22 +0000
  • Delivery-date: Wed, 04 Nov 2009 02:26:52 -0800
  • List-id: Discussion of API issues surrounding Xen <xen-api.lists.xensource.com>

# HG changeset patch
# User Rob Hoes <rob.hoes@xxxxxxxxxx>
# Date 1257330033 0
# Node ID a46e31a77f73c443a93e515bca49ceab01442752
# Parent  8828db3bbdf94804a1ffad02fb65876a729d9b92
[ocamldoc] Intro text on first page of documentation

Signed-off-by: Rob Hoes <rob.hoes@xxxxxxxxxx>

diff -r 8828db3bbdf9 -r a46e31a77f73 ocaml/doc/index.html
--- a/ocaml/doc/index.html      Wed Nov 04 10:20:33 2009 +0000
+++ b/ocaml/doc/index.html      Wed Nov 04 10:20:33 2009 +0000
@@ -16,7 +16,7 @@
        <body onload="build();">
                <div id="wrap">
                        <div id="header">
-                               <h1 style="float:left">Ocaml Code 
Documentation</h1>
+                               <h1 style="float:left">Xapi &ndash; OCaml Code 
Documentation</h1>
                                <ul id="menu">
                                        <script>
                                                document.write('<li><a 
href="index.html">Component Index</a></li>');
@@ -28,7 +28,12 @@
                                </ul>   
                        </div>
                        <div id="main">
-                               <div id="container"><div 
id="content"></div></div>
+                               <div id="container"><div id="content">
+                                       <h1 class="title">Introduction</h1>
+                                       <p>These web pages contain source 
documentation of the main libraries and executables related to xapi. The 
documentation is automatically generated from the OCaml source files via a 
custom generator for <a 
href="http://caml.inria.fr/pub/docs/manual-ocaml/manual029.html"; 
target="_blank">OCamlDoc</a>. Below is a list of all components that are 
covered, the most important one being the <a href="index.html?c=xapi">xapi</a> 
executable itself. Clicking on a component name will bring up an overview of 
the OCaml modules contained in it. Clicking further will reveal the internals 
of a module.</p>
+                                       <p>The OCaml source code contains 
special comments that are displayed in the documentation, which explain the use 
of modules, functions etc. We are working hard to add such comments wherever 
they are needed, but a lot of work still needs to be done. We encourage 
everyone who contributes to xapi to help out and include good documentation! 
:)</p>
+                                       <p>Details on how to generate the 
documentation yourself, and how to properly document the source code, are 
described on <a href="http://wiki.xensource.com/xenwiki/OCaml_Doc"; 
target="_blank">this</a> wiki page.</p>
+                               </div></div>
                                <div id="sidebar"></div>
                                <div id="footer"></div>
                        </div>
diff -r 8828db3bbdf9 -r a46e31a77f73 ocaml/doc/ocamldoc.js
--- a/ocaml/doc/ocamldoc.js     Wed Nov 04 10:20:33 2009 +0000
+++ b/ocaml/doc/ocamldoc.js     Wed Nov 04 10:20:33 2009 +0000
@@ -501,20 +501,21 @@
 function component_index()
 {      
        html = "";
-       html += '<h1 class="title">List of Components</h1>\n';
-       html += "<h2>Executables</h2>";
+       html += '<table><tr>';
+       html += '<td width="30%"><h2>Executables</h2>';
        executables.sort()
        for (i in executables)
                html += '<a href="index.html?c=' + executables[i] + '">' + 
executables[i] + '</a><br />';
-       html += "<h2>Libraries</h2>";
+       html += '</td><td width="30%"><h2>Libraries</h2>';
        libraries.sort()
        for (i in libraries)
                html += '<a href="index.html?c=' + libraries[i] + '">' + 
libraries[i] + '</a><br />';
-       html += "<h2>Packages</h2>";
+       html += '</td><td width="30%"><h2>Packages</h2>';
        packages.sort()
        for (i in packages)
                html += '<a href="index.html?c=' + packages[i] + '">' + 
packages[i] + '</a><br />';
-       set_content(html);
+       html += '</td></tr></table>';
+       append_content(html);
 }
 
 function build()
diff -r 8828db3bbdf9 -r a46e31a77f73 ocaml/doc/style.css
--- a/ocaml/doc/style.css       Wed Nov 04 10:20:33 2009 +0000
+++ b/ocaml/doc/style.css       Wed Nov 04 10:20:33 2009 +0000
@@ -115,8 +115,12 @@
 
 p { padding: 1em 0ex 0em 0em }
 */
-a, a:link, a:visited, a:active, a:hover { color : inherit; text-decoration: 
none; }
+a, a:link, a:visited, a:active, a:hover { color : inherit; text-decoration: 
none;}
 a:hover { color : inherit; text-decoration : underline }
+
+p a {
+       font-weight: bold;
+}
 
 hr {
        border: 1px thin #666;

Attachment: xen-api.hg-3.patch
Description: Text Data

_______________________________________________
xen-api mailing list
xen-api@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/mailman/listinfo/xen-api

 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.