logo       

Re: new API Ref up: msg#00501

web.dojo.devel

Subject: Re: new API Ref up

Wow, that came across a lot ruder than I intended.

What I mean to say is that I precaution people against documenting
something in code the way they think it should be done and file a ticket
assuming it will be accepted. I might end up implementing it, just not
exactly as it was proposed.

-Neil

> Yeah, and my plan for that ticket was to impelement the ability to
> document externally, and then close that ticket as wontfix
>
> FYI, just because a feature request is there doesn't mean it's a good one.
>
> -Neil
>
>> Owen Williams wrote:
>>> Alternatively, we could define an "example" keyword, like the
>>> summary/description/etc keywords, which would be treated just like the
>>> "src" block. It's not as flexible, but would be easy to do.
>>> Separating
>>> out the examples from the summary would be nice from a visual
>>> standpoint
>>> when the API viewer is in "summary" mode.
>>
>> Just FYI, there's a trac ticket for that feature request:
>> http://trac.dojotoolkit.org/ticket/1473
>>
>>
>>
>>> On Oct 29, 2006, at 11:10 PM, Alex Russell wrote:
>>>> Is there some way to get some block of formatting preserved from the
>>>> source comments. In particular, the docs for dojo.event.connect are
>>>> pretty badly mangled and I'd like to know how to "pass through" some
>>>> amount of formatting.
>>>>
>>>> Regards
>> _______________________________________________
>> dojo-contributors mailing list
>> dojo-contributors@xxxxxxxxxxxxxxx
>> http://dojotoolkit.org/mailman/listinfo/dojo-contributors
>>
>
>
> _______________________________________________
> dojo-contributors mailing list
> dojo-contributors@xxxxxxxxxxxxxxx
> http://dojotoolkit.org/mailman/listinfo/dojo-contributors
>


<Prev in Thread] Current Thread [Next in Thread>
Google Custom Search

News | FAQ | advertise