[Mono-osx] I would like to help writing the summary tags for monomac documentation

Miguel de Icaza miguel at novell.com
Sat Oct 16 13:20:35 EDT 2010


Hello,

1. Is there any list of the classes remaining to be documented?
>

There are only docs for the stuff that we share with MonoTouch (anything
that you see in maccore/src)

So pretty much anything else, including:
MonoMac.AppKit
MonoMac.WebKit

You can use grep to find the missing bits:

grep '<summary>To be added' monomac/docs/en/MonoTouch.AppKit/*

2. Is there an example to see what's the desired writing style for the
> documentation?
>

Summaries are just a one-line description, for example for, NSAlert's
summary would be:

<summary>Displays an alert</summary>


>
> Thanks a lot!
>
> _______________________________________________
> Mono-osx mailing list
> Mono-osx at lists.ximian.com
> http://lists.ximian.com/mailman/listinfo/mono-osx
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.ximian.com/pipermail/mono-osx/attachments/20101016/1a4a3e9b/attachment-0001.html 


More information about the Mono-osx mailing list