Opened 13 years ago

Closed 12 years ago

#2312 closed enhancement (wontfix)

more api docs for Widgets.. (diff included)

Reported by: csawyer@… Owned by: Neil Roberts
Priority: high Milestone:
Component: Doc parser Version: 0.4.1
Keywords: Cc:
Blocked By: Blocking:

Description

I've added some more code level docs for the API. I'd like to continue to do this, but not sure if this is the correct method. So this is a minor edit at this point. This is against 'trunk'(rev 7026)

Index: widget/DomWidget.js =================================================================== --- widget/DomWidget.js (revision 7026) +++ widget/DomWidget.js (working copy) @@ -531,7 +531,7 @@

getFragNodeRef: function(frag){

summary: returns the source node, if any, that the widget was

  • declared from

+ declared from. returns <span> node if not declared.

frag: Object an opaque data structure generated by the first-pass parser if(!frag){return null;} null

Index: widget/InlineEditBox.js =================================================================== --- widget/InlineEditBox.js (revision 7026) +++ widget/InlineEditBox.js (working copy) @@ -13,10 +13,11 @@

dojo.widget.HtmlWidget?, function(){

summary

  • Given node is displayed as-is (for example, an <h1 dojoType="InlineEditBox?">
  • is displayed as an <h1>, but when you click on it, it turns into an
  • <input> or <textarea>, and the user can edit the value.

- + Given node is displayed as-is (for example, an h1 dojoType="InlineEditBox?" + is displayed as an h1, but when you click on it, it turns into an + input or textarea (depending on the mode argument), and the user can edit the value. + If used programatically(dojo.widget.createWidget) you really need to feed the 3 argument(domNode) to replace. +

mutable objects need to be in constructor to give each instance its own copy this.history = [];

},

Attachments (1)

docdiff (1.4 KB) - added by csawyer@… 13 years ago.
doc diff against trunk for 2312.

Download all attachments as: .zip

Change History (3)

Changed 13 years ago by csawyer@…

Attachment: docdiff added

doc diff against trunk for 2312.

comment:1 Changed 13 years ago by guest

I have a CCLA by my employer (Yuma Union High School District #70).

comment:2 Changed 12 years ago by Adam Peller

Resolution: wontfix
Status: newclosed

I don't think these docs apply to dijit

Note: See TracTickets for help on using tickets.