[Mono-docs-list] Monodoc README, NOTES, TODO updates

[John Luke]

--=-UXVTrRXE6/h6a9NnQSz0
Content-Type: text/plain
Content-Transfer-Encoding: 7bit

Hello,

Here is a small patch for README, TODO, and NOTES that updates them
somewhat.  However, I am sure there is more.  Can I commit?

John Luke

--=-UXVTrRXE6/h6a9NnQSz0
Content-Disposition: attachment; filename=monodoc.diff
Content-Type: text/x-patch; name=monodoc.diff; charset=UTF-8
Content-Transfer-Encoding: 7bit

Index: README
===================================================================
RCS file: /cvs/public/monodoc/README,v
retrieving revision 1.5
diff -u -r1.5 README
--- README	21 Feb 2003 02:36:06 -0000	1.5
+++ README	19 Jun 2003 03:41:34 -0000
@@ -2,10 +2,8 @@
 -------
 
 	This is the MonoDoc module.  It contains the documentation for
-	the Mono class libraries as well as tools to produce and edit
-	the documentation.
-
-	Hopefully we will also soon have a documentation browser.
+	the Mono class libraries, tools to produce and edit the
+	documentation, and a documentation browser.
 
 * Format
 
@@ -60,9 +58,8 @@
 * Editing tools.
 
 	We are in the process of developing a tool called `monodoc'
-	which is a Gtk#-based documentation editor that would simplify
-	the editing of the ECMA-xml documentation.  This tool is
-	currently not finished, but it lives in tools/gtk-monodoc.
+	which is a Gtk#-based documentation editor that simplifies
+	the editing of the ECMA-xml documentation.
 
 * Documentation tools.
 
@@ -90,18 +87,12 @@
 	1) Make sure you don't have any GAL headers installed. If you
            have the gal-devel package installed, remove it.
 
-	2) Check the following two modules from the GNOME CVS
-           repository (http://developer.gnome.org/tools/cvs.html):
-
-	      cvs co gal
-	      cvs co gtkhtml (this is the HEAD branch)
+	2) Install gal 1.99 (sometimes called libgal2) and gtkhtml3 or
+           newer. Rpm's are available through red-carpet or the
+           source is on the gnome ftp site if your distribution
+           does not provide binary packages.
 
-	3) Build gal, then gtkhtml. Make sure they are all installed to the
-           same prefix.
-
-	4) Install Gtk#. RPMs are available here
+	3) Install Gtk#. RPMs are available here
            (http://gtk-sharp.sourceforge.net/). You can check it out
            from the Mono CVS repository under the module name
            'gtk-sharp'.
-
-	   
Index: browser/NOTES
===================================================================
RCS file: /cvs/public/monodoc/browser/NOTES,v
retrieving revision 1.7
diff -u -r1.7 NOTES
--- browser/NOTES	30 Apr 2003 22:45:17 -0000	1.7
+++ browser/NOTES	19 Jun 2003 03:41:34 -0000
@@ -142,10 +142,14 @@
 	type lookups.  The prefix is one of "T:", "M:", "E:" and "F:",
 	and they represent:
 
-		"T:" types (class, struct, interfaces, delegates)
-		"M:" methods (includes the method signature)
-		"E:" Events
-		"F:" Fields.
+        "T:" Types (classes, structs, interfaces, enumerations), example: (T:System.Byte)
+        "M:" Method, example: (M:System.String.Substring(System.Int32,System.Int32))
+        "P:" Properties, example: (P:System.AppDomain.CurrentDomain)
+        "N:" Namespaces, example (N:System).
+        "C:" Constructors, example (C:Gtk.Button())
+        "E:" Events, example (E:Gtk.Button.Clicked)
+        "F:" Fields, example (F:Gtk.TreeIter.Zero)
+
 
 	RenderNamespaceLookup is used by providers that can render
 	namespace lookups, and those are urls that encode the "N:"
Index: browser/TODO
===================================================================
RCS file: /cvs/public/monodoc/browser/TODO,v
retrieving revision 1.15
diff -u -r1.15 TODO
--- browser/TODO	27 May 2003 03:45:39 -0000	1.15
+++ browser/TODO	19 Jun 2003 03:41:34 -0000
@@ -12,27 +12,11 @@
 	should be sorted'.
 
 * Browser
-
-	We need to handle all links, known missing:
-
-		M:TypeName.Method(typeargs)
-		F:TypeName.Field
-		E:TypeName.Event
-
-	The decoupling of ns/type/member fails for methods, we should
-	scan for the "(" before trying to compute ns/type from a
-	ns/type/member/args string:
-
-		M:System.Int32.Parse(System.Int32)
 	
 	Add support for printing (requires GnomePrint# support)
 
 	Add bookmark facility
 
-* Summaries:
-
-	Render members in sorted order
-
 * Ecma provider:
 
 	In summaries, if there is a single paragraph, peel the outer
@@ -42,7 +26,7 @@
 
 	Should detect method overloads and create a node for those.
 
-	Handle refrences to sample code, and generate a link in the
+	Handle references to sample code, and generate a link in the
   	browser to use it.
 
 * Mono-Man-Page provider:

--=-UXVTrRXE6/h6a9NnQSz0--