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

Miguel de Icaza miguel at novell.com
Mon Oct 25 13:27:28 EDT 2010


Hello Pablo,

    Let us say some 40?

    If you are planning on being active on this space, I can also give you
commit access.

Miguel.

On Sat, Oct 23, 2010 at 10:35 AM, Pablo Santa Cruz
<pablojavierpy at gmail.com>wrote:

> How many classes documentation should I write before trying to send you
> guys a patch?
>
> Thanks!
>
> On Oct 17, 2010, at 12:55 AM, Miguel de Icaza wrote:
>
> Hello,
>
>     It is always better to summarize things on your own words.
>
>     If you copy paste the text, then you need to get permission from Apple,
> as that text is copyrighted by them.
>
> On Sat, Oct 16, 2010 at 4:19 PM, Richard de Zwart <mountain at xs4all.nl>wrote:
>
>>  BTW, is it ok to copy the summaries from the Apple Mac OSX Reference
>> Library, or is there some copyright issue and should I rephrase it?
>>
>>
>> Richard
>>
>> On 10/16/10 7:20 PM, Miguel de Icaza wrote:
>>
>> 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
>>>
>>>
>>
>> _______________________________________________
>> Mono-osx mailing listMono-osx at lists.ximian.comhttp://lists.ximian.com/mailman/listinfo/mono-osx
>>
>>
>> _______________________________________________
>> Mono-osx mailing list
>> Mono-osx at lists.ximian.com
>> http://lists.ximian.com/mailman/listinfo/mono-osx
>>
>>
> _______________________________________________
> Mono-osx mailing list
> Mono-osx at lists.ximian.com
> http://lists.ximian.com/mailman/listinfo/mono-osx
>
>
>
> _______________________________________________
> 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/20101025/f2cf9708/attachment.html 


More information about the Mono-osx mailing list