[Xlw-cvs] SF.net SVN: xlw: [542] branches/R030000f0-branch/xlw

[<eri...@us...>]

Revision: 542
          http://xlw.svn.sourceforge.net/xlw/?rev=542&view=rev
Author:   ericehlers
Date:     2008-05-21 02:33:46 -0700 (Wed, 21 May 2008)

Log Message:
-----------
update docs

Modified Paths:
--------------
    branches/R030000f0-branch/xlw/History.txt
    branches/R030000f0-branch/xlw/docs/README.txt
    branches/R030000f0-branch/xlw-site/index.shtml
    branches/R030000f0-branch/xlw-site/project.shtml

Added Paths:
-----------
    branches/R030000f0-branch/xlw/docs/xlwplus2/README.txt
    branches/R030000f0-branch/xlw-site/README.txt

Modified: branches/R030000f0-branch/xlw/History.txt
===================================================================
--- branches/R030000f0-branch/xlw/History.txt	2008-05-19 13:24:24 UTC (rev 541)
+++ branches/R030000f0-branch/xlw/History.txt	2008-05-21 09:33:46 UTC (rev 542)
@@ -2,7 +2,7 @@
 For more info visit
 http://xlw.sourceforge.net/history.shtml
 
-2008-03-19 version 3.0.0
+2008-05-11 version 3.0.0
 
 2007-04-22 version 2.1.0
 

Modified: branches/R030000f0-branch/xlw/docs/README.txt
===================================================================
--- branches/R030000f0-branch/xlw/docs/README.txt	2008-05-19 13:24:24 UTC (rev 541)
+++ branches/R030000f0-branch/xlw/docs/README.txt	2008-05-21 09:33:46 UTC (rev 542)
@@ -1,6 +1,20 @@
 
 $Id$
 
+The doxygen utility is used to generate the documentation based on comments extracted from the source code.  The current configuration relies on doxygen version 1.5.5.
+
+To build the documentation under Linux, do 'make'.  This uses configuration
+xlw.linux.doxy and writes the docs in html format to the html subdirectory.
+
+To build the documentation under Windows, use the DOS batch file run_doxygen.bat.  This uses configuration xlw.windows.doxy, in addition to html a chm file is produced.
+
+The html directory should be kept in synch with the refman directory on the website.
+
+Refer to the xlwplus2 subdirectory for documentation relating to the InterfaceGenerator utility and other features.
+
+Below are some older comments which remain largely relevant.
+============================================================
+
 The documentation is automatically extracted from the source code using
 DoxyGen (http://www.stack.nl/~dimitri/doxygen/).
 The current version we're using is 1.2.11.1

Added: branches/R030000f0-branch/xlw/docs/xlwplus2/README.txt
===================================================================
--- branches/R030000f0-branch/xlw/docs/xlwplus2/README.txt	                        (rev 0)
+++ branches/R030000f0-branch/xlw/docs/xlwplus2/README.txt	2008-05-21 09:33:46 UTC (rev 542)
@@ -0,0 +1,9 @@
+
+$Id: README.txt 221 2003-04-22 12:41:13Z nando $
+
+This directory contains the documentation for xlw version 2, including the InterfaceGenerator utility.
+
+To create the documentation under Linux, type 'make'.  It is also possible to generate the documentation under Windows but no build environment is maintained for that platform.
+
+The Linux build creates file xlwplus2.pdf, and generates the doc in html format in subdirectories html-singlepage and html-multipage.  Directory html-singlepage should be kept in synch with directory version2 on the website.
+


Property changes on: branches/R030000f0-branch/xlw/docs/xlwplus2/README.txt
___________________________________________________________________
Name: svn:eol-style
   + native

Added: branches/R030000f0-branch/xlw-site/README.txt
===================================================================
--- branches/R030000f0-branch/xlw-site/README.txt	                        (rev 0)
+++ branches/R030000f0-branch/xlw-site/README.txt	2008-05-21 09:33:46 UTC (rev 542)
@@ -0,0 +1,20 @@
+
+$Id: README.txt 221 2003-04-22 12:41:13Z nando $
+
+This directory contains the files for the website.  The files rely on server side includes.  If you have these pages on your hard drive and want to view them in the browser, add the following lines to your Apache configuration file:
+
+Alias /xlw/ "/path/to/xlw-site/"
+
+<Directory "/path/to/xlw-site/">
+    Options Indexes MultiViews FollowSymLinks Includes
+    AllowOverride None
+    Order allow,deny
+    Allow from all
+</Directory>
+
+Then (re)start Apache and point your browser at
+
+    http://localhost/xlw/index.shtml
+
+Subdirectory refman is taken from xlw/docs/html, and subdirectory version2 is taken from xlw/docs/xlwplus2/html-singlepage.
+


Property changes on: branches/R030000f0-branch/xlw-site/README.txt
___________________________________________________________________
Name: svn:eol-style
   + native

Modified: branches/R030000f0-branch/xlw-site/index.shtml
===================================================================
--- branches/R030000f0-branch/xlw-site/index.shtml	2008-05-19 13:24:24 UTC (rev 541)
+++ branches/R030000f0-branch/xlw-site/index.shtml	2008-05-21 09:33:46 UTC (rev 542)
@@ -12,8 +12,6 @@
 <span class="preprocessor">#ifndef TEST_H</span>
 <span class="preprocessor">#define TEST_H</span>
 
-<span class="preprocessor">#include &lt;xlw/xlw.h&gt;</span>
-
 <span class="comment">//&lt;xlw:libraryname=MyTestLibrary</span>
 
 std::wstring <span class="comment">// Concatenate two strings</span>

Modified: branches/R030000f0-branch/xlw-site/project.shtml
===================================================================
--- branches/R030000f0-branch/xlw-site/project.shtml	2008-05-19 13:24:24 UTC (rev 541)
+++ branches/R030000f0-branch/xlw-site/project.shtml	2008-05-21 09:33:46 UTC (rev 542)
@@ -6,7 +6,7 @@
 <br>
 <p>There you can find various project resources including:</p>
 <br>
-<p><ul><li>Downloads for source code, documentation and examples</li>
+<p><ul><li>Downloads for code, documentation and examples</li>
 <li>Mailing lists and archives</li>
 <li>Bug tracker and feature requests</li>
 <li>Subversion source code repository</li></ul></p>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.