Document Mono.Cairo Part 1
completed by: knairda
mentors: Miguel de Icaza
Github Module: mono/mono
Command: monodoc --edit mono/mcs/class/Mono.Cairo/Documentation/en
The task is to completely document the following classes, this includes: class summary, a property, a method, an event and so on. Everything in the XML files that has the word "To be added.":
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
* Bonus point: throw in some samples if you do not mind.
Most of the documentation needs to be "translated" from the original sources. In Mono.Cairo's case, it is the Cairo documentation. The best thing to do is to look at the source code for Mono.Cairo see what C function is being called and then fill in the blanks based on the C documentation, or the results from Googling the information.
You can edit the documentation in Linux using the Monodoc tool, like this:
monodoc --edit directory_with_xml_files
IMPORTANT: Once you have edited those files, you can submit the documentation with git (Do not use the built-in collaboration/submission feature of Monodoc)