Re: new API Ref up

There should be no markup in comments. This is what the external storage
is for, for exactly this type of thing. I'll get this working as fast as I
can, but the parser does not handle code inside of comments inside of
code.

-Neil

> I assume you're referring to the "pre" formatting (indentation and
> newlines) of the dojo.event.connect examples in that function.
>
> The parser is outputting the "summary" in the "local/json" output
> without newlines or any new line markers, and smooshing all the white
> space, so there's nothing I can do in the front end at this point.
> What I suggest is this:
>
> 1) we come up with a convention to indicate "this is a code block" in
> comments
> 2) the parser encodes newlines as "\n" and leaves in spaces in
> summary/description blocks (like it does with src blocks)
> 3) the front end will strip out all newlines except those that sit
> inside a code block, and will <pre> (at least) the code blocks.
>
> 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.
>
> Also, Alex, I recommend that extended text like that go in a
> "description" block rather than "summary."
>
> Thoughts?  Neil?
>
> thanks
> O
>
> -------------------------
> Whenever I despair, I remember that the way of truth and love has
> always won. There may be tyrants and murderers, and for a time, they
> may seem invincible, but in the end, they always fail. Think of it:
> always.  -- Mohandas K. Ghandi
>
>
> 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
>>
>> On Sunday 29 October 2006 9:17 pm, Owen Williams wrote:
>>> http://dojotoolkit.org/api
>>>
>>> No functional changes, just updated to use new parser output.
>>>
>>> Checked in as revision 6368.
>>>
>>> Enjoy
>>> O
>>> -------------------------
>>> Whenever I despair, I remember that the way of truth and love has
>>> always won. There may be tyrants and murderers, and for a time, they
>>> may seem invincible, but in the end, they always fail. Think of it:
>>> always.  -- Mohandas K. Ghandi
>>
>> --
>> Alex Russell
>> alex@xxxxxxxxxxx     A99F 8785 F491 D5FD 04D7 ACD9 4158 FFDF 2894 6876
>> alex@xxxxxxxxxxxxxxx BE03 E88D EABB 2116 CC49 8259 CF78 E242 59C3 9723
>> _______________________________________________
>> 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
>