We need to provide documentation for many classes:
* Mono.Cairo
* Gtk# and all of its namespaces
* Mono.Cecil
* MonoMac
* Mono.Remoting.Channels.Unix
* Others: ask (we are not documenting Microsoft APIs)
The task is to complete document 50 members. A member is either a class
summary, a property, a method, an event and so on. For MonoMac, only do the
summary-lines and instead of 30 fully documented members, since the work is
simpler (just the summary line, we are not doing remarks/parameters for MonoMac
at all) they are 90 summaries or 50 summaries with examples for the APIs.
The documentation for each of those elements consists of:
* One-line summary
* Remarks section that contains relevant information about the method
* Parameters (if available)
* Return values
Most of the documentation needs to be "translated" from the original sources.
In Gtk#'s case it is the Gtk+ documentation in C that needs to be transformed
into C# documentation. In Mono.Cairo's case, it is the Cairo documentation.
Classes must come with a small use sample.
When documentation is not available, the information on the API can be gathered
by Googling for the API, or for the underlying API that Mono wraps/binds.
For Mono:
Documentation is available as part of the `mono/mono' module on github,
documentation lives in the mono/mcs/class/?????/Documentation directory.
For Gtk#:
that lives in the mono/gtk-sharp module on github
For MonoMac:
That lives in the `mono/monomac' module in the `docs/en' directory. NOTICE:
Only a few namespace are being documented (AppKit, WebKit, QtKit, CoreData,
ImageIO) as this documentation gets merged with another tree.
Full documentation rules (30 members, with remarks) are needed for
CoreGraphics, CoreText, AudioToolbox)
Original issue reported on code.google.com by miguel.n...@gmail.com on 22 Nov 2010 at 4:25
Original issue reported on code.google.com by
miguel.n...@gmail.com
on 22 Nov 2010 at 4:25