Monday, October 10, 2005

Documenting is a Good-ThingTM

I've been cleaning and writing some documentation on the Wiki regarding Monodoc. The problem is that, lately, my english is more broken that it should be (probably due to my year in Germany and that I haven't study english since..since..a lot).

Well, the thing is that someone please check the pages I modified. Here is the list:

http://www.mono-project.com/Monodoc
http://www.mono-project.com/Monodoc_Editing
http://www.mono-project.com/Generating_Documentation
http://www.mono-project.com/Monodocer
http://www.mono-project.com/Monodoc_Contributing

Of course, I will also appreciate all types of comments: style, things not clearly explained, things that lack. The Monodocer page should be reviewed a lot and, also, I have to add an Assembler page (the link is there but I didn't write the page yet).

I recommend you to grab the SVN version of monodoc and mono-tools as some minor bugs are corrected. They were little annoying things that appear when using uncompiled sources from monodoc (the ones being created by monodocer). The bug that hanged Gecko-sharp when visiting big pages is also corrected.

There is yet one more bug that makes Monodoc browser to hang, which is really difficult to track. It doesn't reproduce in the same docs (at least, the docs of the bug review doesn't hang monodoc for me, but the same error appears in other places) and is due to a cast from an String somewhere in Gtk. The point is that, the same code is used once and again (setting the title label, near the back/forward arrows) and nothings happens until you enter some specific docs. I will need to sit down and spend some time on this.

Just one last question. Why don't try monodocer/monodoc for documenting your libraries?

9 comments:

Anonymous said...

Is it just me, or do all of those 5 links post to http://www.mono-project.com/Monodoc ?

Roy Tate said...

I reviewed these pages, and I can offer the following corrections:
-BEGIN-
http://www.mono-project.com/Monodoc

secion = section

-----
http://www.mono-project.com/Generating_Documentation

"information reggarding the" = "information regarding the"

"do not loose the" = "do not lose the"

"our documentation is preferable" = "our documentation, it is preferable"

-----
http://www.mono-project.com/Monodoc_Contributing

"Aside form the core" = "Aside from the core"

"information with resembles" = "information which resembles"

-END-

Of course, the format is "EXISTING PHRASE = CORRECTED PHRASE".

Anonymous said...

About your question, why I don't use monodoc to document libraries (my own or Mono's), is quite simple to answer: I can't (bug #76346)

Anonymous said...

Hi people
I do not know what to give for Christmas of the to friends, advise something ....

Anonymous said...

Hello. Good day
Who listens to what music?
I Love songs Justin Timberlake and Paris Hilton

Anonymous said...

I am really excited! This will be my first time visiting, good stuff. Very useful. Enjoyed the visit!
- msopena.blogspot.com 8
07 car civic honda
buy used car
car undefined used
used car bergen
used car oakland
used car greensboro
used car raleigh
used car killeen
used car vallejo
used car tacoma

Anonymous said...

[url=http://teenboat.blogspot.com]teenboad[/url]
teenboad
http://teenboat.blogspot.com

Anonymous said...

black mold exposure,
black mold symptoms of exposure,

wrought iron garden gates,
your nest iron garden gates, here,

hair styles for fine thin hair,
search hair styles for fine thin hair,

night vision binoculars,
buy, night vision binoculars,

lipitor reactions,
lipitor reactions,


luxury beach resort in the philippines,
beach resort in the philippines,

homeopathy for baby eczema.,
homeopathy for eczema learn about it.,

save big with great mineral makeup bargains,
companies marketing mineral makeups,

Anonymous said...

I have very interesting web sites please visit them.
ultram
skelaxin
cyclobenzaprine
remeronon
flexeril
wellbutrin
acyclovir
nexium