Changeset 4904
- Timestamp:
- 01/08/10 12:19:16 (3 years ago)
- Location:
- CKEditor/trunk
- Files:
-
- 12 edited
-
_dev/_thirdparty (modified) (1 prop)
-
_dev/docs_build/docs_build.conf (modified) (1 diff)
-
_dev/docs_build/template/allfiles.tmpl (modified) (2 diffs)
-
_dev/docs_build/template/class.tmpl (modified) (7 diffs)
-
_dev/docs_build/template/index.tmpl (modified) (1 diff)
-
_dev/docs_build/template/publish.js (modified) (13 diffs)
-
_source/core/ckeditor_basic.js (modified) (1 diff)
-
_source/core/dom/document.js (modified) (6 diffs)
-
_source/core/dom/domobject.js (modified) (2 diffs)
-
_source/core/dom/element.js (modified) (1 diff)
-
_source/core/dom/node.js (modified) (1 diff)
-
_source/plugins/domiterator/plugin.js (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
-
CKEditor/trunk/_dev/_thirdparty
- Property svn:externals
-
old new 1 jsdoc-toolkit http://jsdoc-toolkit.googlecode.com/svn/tags/jsdoc_toolkit-2. 0.2/jsdoc-toolkit1 jsdoc-toolkit http://jsdoc-toolkit.googlecode.com/svn/tags/jsdoc_toolkit-2.3.2/jsdoc-toolkit
-
- Property svn:externals
-
CKEditor/trunk/_dev/docs_build/docs_build.conf
r4040 r4904 17 17 '../../_source/core/', 18 18 '../../_source/plugins/', 19 '../../_source/skins/kama/skin.js', 20 '../../_source/lang/en.js' 19 '../../_source/skins/kama/skin.js' 20 ], 21 22 // Files to exclude. 23 E: 24 [ 25 'yui.js' 21 26 ], 22 27 -
CKEditor/trunk/_dev/docs_build/template/allfiles.tmpl
r4901 r4904 3 3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 4 4 <head> 5 <meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" "/>5 <meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" /> 6 6 {! Link.base = ""; /* all generated links will be relative to this */ !} 7 7 <title>File Index - CKEditor 3 JavaScript API Documentation</title> … … 26 26 <div> 27 27 <h2>{+new Link().toSrc(item.alias).withText(item.name)+}</h2> 28 <if test="item.desc">{+resolveLinks( summarize(item.desc))+}</if>28 <if test="item.desc">{+resolveLinks(item.desc)+}</if> 29 29 <dl> 30 30 <if test="item.author"> -
CKEditor/trunk/_dev/docs_build/template/class.tmpl
r4901 r4904 51 51 <!-- ============================== class summary ========================== --> 52 52 <p class="description"> 53 <if test="data.version"><br />Version 54 {+ data.version +}.<br /> 55 </if> 53 56 <if test="data.augments.length"><br />Extends 54 57 {+ … … 210 213 !} </td> 211 214 <td class="nameDescription"> 212 <div class="fixedFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name )+}</b>{+makeSignature(member.params)+}215 <div class="fixedFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name.replace(/\^\d+$/, ''))+}</b>{+makeSignature(member.params)+} 213 216 </div> 214 217 <div class="description">{+resolveLinks(summarize(member.desc))+}</div> … … 249 252 </if> 250 253 254 <!-- ============================== events summary ======================== --> 255 <if test="data.events.length"> 256 {! var ownEvents = data.events.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !} 257 <if test="ownEvents.length"> 258 <table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class {+data.alias+}."> 259 <caption>Event Summary</caption> 260 <thead> 261 <tr> 262 <th scope="col">Event Attributes</th> 263 <th scope="col">Event Name and Description</th> 264 </tr> 265 </thead> 266 <tbody> 267 <for each="member" in="ownEvents"> 268 <tr> 269 <td class="attributes">{! 270 if (member.isPrivate) output += "<private> "; 271 if (member.isInner) output += "<inner> "; 272 if (member.isStatic) output += "<static> "; 273 !} </td> 274 <td class="nameDescription"> 275 <div class="fixedFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b>{+makeSignature(member.params)+} 276 </div> 277 <div class="description">{+resolveLinks(summarize(member.desc))+}</div> 278 </td> 279 </tr> 280 </for> 281 </tbody> 282 </table> 283 </if> 284 285 <if test="data.inheritsFrom.length"> 286 <dl class="inheritsList"> 287 {! 288 var borrowedMembers = data.events.filter(function($) {return $.memberOf != data.alias}); 289 var contributers = []; 290 borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); 291 for (var i = 0, l = contributers.length; i < l; i++) { 292 output += 293 "<dt>Events borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>" 294 + 295 "<dd>" + 296 borrowedMembers 297 .filter( 298 function($) { return $.memberOf == contributers[i] } 299 ) 300 .sort(makeSortby("name")) 301 .map( 302 function($) { return new Link().toSymbol($.alias).withText($.name) } 303 ) 304 .join(", ") 305 + 306 "</dd>"; 307 } 308 309 !} 310 </dl> 311 </if> 312 </if> 313 251 314 <!-- ============================== constructor details ==================== --> 252 315 <if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))"> … … 398 461 <dt class="heading">Deprecated:</dt> 399 462 <dt> 400 {+ member.deprecated+}463 {+ resolveLinks(member.deprecated) +} 401 464 </dt> 402 465 </dl> … … 437 500 438 501 <span class="light">{{+ new Link().toSymbol( member.type || 'Undefined') +}}</span> 439 <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name +}</b>{+makeSignature(member.params)+}502 <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name.replace(/\^\d+$/, '')+}</b>{+makeSignature(member.params)+} 440 503 441 504 </div> … … 484 547 <dt class="heading">Deprecated:</dt> 485 548 <dt> 486 {+ member.deprecated+}549 {+resolveLinks(member.deprecated)+} 487 550 </dt> 488 551 </dl> … … 527 590 </for> 528 591 </if> 529 592 593 <!-- ============================== event details ========================= --> 594 <if test="defined(ownEvents) && ownEvents.length"> 595 <div class="sectionTitle"> 596 Event Detail 597 </div> 598 <for each="member" in="ownEvents"> 599 <a name="event:{+Link.symbolNameToLinkName(member)+}"> </a> 600 <div class="fixedFont">{! 601 if (member.isPrivate) output += "<private> "; 602 if (member.isInner) output += "<inner> "; 603 if (member.isStatic) output += "<static> "; 604 !} 605 606 <if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if> 607 <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>{+makeSignature(member.params)+} 608 609 </div> 610 <div class="description"> 611 {+resolveLinks(member.desc)+} 612 <if test="member.srcFile != data.srcFile"> 613 <br /> 614 <i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}. 615 </if> 616 <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if> 617 </div> 618 619 <if test="member.example.length"> 620 <for each="example" in="member.example"> 621 <pre class="code">{+example+}</pre> 622 </for> 623 </if> 624 625 <if test="member.params.length"> 626 <dl class="detailList"> 627 <dt class="heading">Parameters:</dt> 628 <for each="item" in="member.params"> 629 <dt> 630 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b> 631 <if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if> 632 </dt> 633 <dd>{+ resolveLinks(item.desc) +}</dd> 634 </for> 635 </dl> 636 </if> 637 <if test="member.deprecated"> 638 <dl class="detailList"> 639 <dt class="heading">Deprecated:</dt> 640 <dt> 641 {+ resolveLinks(member.deprecated) +} 642 </dt> 643 </dl> 644 </if> 645 <if test="member.since"> 646 <dl class="detailList"> 647 <dt class="heading">Since:</dt> 648 <dd>{+ member.since +}</dd> 649 </dl> 650 </dl> 651 </if> 652 <if test="member.exceptions.length"> 653 <dl class="detailList"> 654 <dt class="heading">Throws:</dt> 655 <for each="item" in="member.exceptions"> 656 <dt> 657 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b> 658 </dt> 659 <dd>{+ resolveLinks(item.desc) +}</dd> 660 </for> 661 </dl> 662 </if> 663 <if test="member.returns.length"> 664 <dl class="detailList"> 665 <dt class="heading">Returns:</dt> 666 <for each="item" in="member.returns"> 667 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd> 668 </for> 669 </dl> 670 </if> 671 <if test="member.requires.length"> 672 <dl class="detailList"> 673 <dt class="heading">Requires:</dt> 674 <for each="item" in="member.requires"> 675 <dd>{+ resolveLinks(item) +}</dd> 676 </for> 677 </dl> 678 </if> 679 <if test="member.see.length"> 680 <dl class="detailList"> 681 <dt class="heading">See:</dt> 682 <for each="item" in="member.see"> 683 <dd>{+ new Link().toSymbol(item) +}</dd> 684 </for> 685 </dl> 686 </if> 687 688 <if test="!$member_last"><hr /></if> 689 </for> 690 </if> 691 530 692 <hr /> 531 693 </div> -
CKEditor/trunk/_dev/docs_build/template/index.tmpl
r4901 r4904 3 3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 4 4 <head> 5 <meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" "/>5 <meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" /> 6 6 7 7 <title>CKEditor 3 JavaScript API Documentation</title> -
CKEditor/trunk/_dev/docs_build/template/publish.js
r3260 r4904 1 /** Called automatically by JsDoc Toolkit. */ 1 2 function publish(symbolSet) { 2 3 publish.conf = { // trailing slash expected for dirs 3 ext: ".html",4 outDir: JSDOC.opt.d || SYS.pwd+"../out/jsdoc/",5 templatesDir: JSDOC.opt.t.replace( /\/+$/, '' ) + '/',6 symbolsDir: "symbols/",7 srcDir: "symbols/src/"4 ext: ".html", 5 outDir: JSDOC.opt.d || SYS.pwd+"../out/jsdoc/", 6 templatesDir: ( JSDOC.opt.t && JSDOC.opt.t.replace( /\/+$/, '' ) + '/' ) || SYS.pwd+"../templates/jsdoc/", 7 symbolsDir: "symbols/", 8 srcDir: "symbols/src/" 8 9 }; 9 10 if (!IO.exists(publish.conf.templatesDir)) { … … 11 12 } 12 13 14 // is source output is suppressed, just display the links to the source file 13 15 if (JSDOC.opt.s && defined(Link) && Link.prototype._makeSrcLink) { 14 16 Link.prototype._makeSrcLink = function(srcFilePath) { … … 17 19 } 18 20 21 // create the folders and subfolders to hold the output 19 22 IO.mkPath((publish.conf.outDir+"symbols/src").split("/")); 20 23 21 // used to check the details of things being linked to24 // used to allow Link to check the details of things being linked to 22 25 Link.symbolSet = symbolSet; 23 26 27 // create the required templates 24 28 try { 25 29 var classTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"class.tmpl"); … … 27 31 } 28 32 catch(e) { 29 print( e.message);33 print("Couldn't create the required templates: "+e); 30 34 quit(); 31 35 } 32 36 33 // filters37 // some ustility filters 34 38 function hasNoParent($) {return ($.memberOf == "")} 35 39 function isaFile($) {return ($.is("FILE"))} 36 40 function isaClass($) {return ($.is("CONSTRUCTOR") || $.isNamespace)} 37 41 42 // get an array version of the symbolset, useful for filtering 38 43 var symbols = symbolSet.toArray(); 39 44 45 // create the hilited source code files 40 46 var files = JSDOC.opt.srcFiles; 41 47 for (var i = 0, l = files.length; i < l; i++) { … … 45 51 } 46 52 53 // get a list of all the classes in the symbolset 47 54 var classes = symbols.filter(isaClass).sort(makeSortby("alias")); 48 55 56 // create a filemap in which outfiles must be to be named uniquely, ignoring case 57 if (JSDOC.opt.u) { 58 var filemapCounts = {}; 59 Link.filemap = {}; 60 for (var i = 0, l = classes.length; i < l; i++) { 61 var lcAlias = classes[i].alias.toLowerCase(); 62 63 if (!filemapCounts[lcAlias]) filemapCounts[lcAlias] = 1; 64 else filemapCounts[lcAlias]++; 65 66 Link.filemap[classes[i].alias] = 67 (filemapCounts[lcAlias] > 1)? 68 lcAlias+"_"+filemapCounts[lcAlias] : lcAlias; 69 } 70 } 71 72 // create a class index, displayed in the left-hand column of every class page 49 73 Link.base = "../"; 50 74 publish.classesIndex = classesTemplate.process(classes); // kept in memory 51 75 76 // create each of the class pages 52 77 for (var i = 0, l = classes.length; i < l; i++) { 53 78 var symbol = classes[i]; 79 80 symbol.events = symbol.getEvents(); // 1 order matters 81 symbol.methods = symbol.getMethods(); // 2 82 54 83 var output = ""; 55 84 output = classTemplate.process(symbol); 56 85 57 IO.saveFile(publish.conf.outDir+"symbols/", symbol.alias+publish.conf.ext, output);58 } 59 60 // regen rate the index with different relative links86 IO.saveFile(publish.conf.outDir+"symbols/", ((JSDOC.opt.u)? Link.filemap[symbol.alias] : symbol.alias) + publish.conf.ext, output); 87 } 88 89 // regenerate the index with different relative links, used in the index pages 61 90 Link.base = ""; 62 91 publish.classesIndex = classesTemplate.process(classes); 63 92 93 // create the class index page 64 94 try { 65 95 var classesindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"index.tmpl"); … … 71 101 classesindexTemplate = classesIndex = classes = null; 72 102 103 // create the file index page 73 104 try { 74 105 var fileindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allfiles.tmpl"); … … 76 107 catch(e) { print(e.message); quit(); } 77 108 78 var documentedFiles = symbols.filter(isaFile); 79 var allFiles = []; 109 var documentedFiles = symbols.filter(isaFile); // files that have file-level docs 110 var allFiles = []; // not all files have file-level docs, but we need to list every one 80 111 81 112 for (var i = 0; i < files.length; i++) { … … 96 127 allFiles = allFiles.sort( ckeditor_sortFiles ); 97 128 129 // output the file index page 98 130 var filesIndex = fileindexTemplate.process(allFiles); 99 131 IO.saveFile(publish.conf.outDir, "files"+publish.conf.ext, filesIndex); … … 102 134 103 135 104 /** Just the first sentence . Should not break on dotted variable names. */136 /** Just the first sentence (up to a full stop). Should not break on dotted variable names. */ 105 137 function summarize(desc) { 106 138 if (typeof desc != "undefined") … … 108 140 } 109 141 110 /** make a symbol sorter by some attribute*/142 /** Make a symbol sorter by some attribute. */ 111 143 function makeSortby(attribute) { 112 144 return function(a, b) { … … 121 153 } 122 154 155 /** Pull in the contents of an external file at the given path. */ 123 156 function include(path) { 124 157 var path = publish.conf.templatesDir+path; … … 126 159 } 127 160 161 /** Turn a raw source file into a code-hilited page in the docs. */ 128 162 function makeSrcFile(path, srcDir, name) { 129 163 if (JSDOC.opt.s) return; … … 145 179 } 146 180 181 /** Build output for displaying function parameters. */ 147 182 function makeSignature(params) { 148 183 if (!params) return "()"; -
CKEditor/trunk/_source/core/ckeditor_basic.js
r4858 r4904 138 138 }; 139 139 140 /* *140 /* 141 141 * @ignore 142 142 * Documented at ckeditor.js. -
CKEditor/trunk/_source/core/dom/document.js
r4858 r4904 169 169 170 170 return ( 171 /** @ignore */172 171 this.getHead = function() 173 172 { … … 188 187 189 188 return ( 190 /** @ignore */191 189 this.getBody = function() 192 190 { … … 195 193 }, 196 194 195 /** 196 * Gets the DOM document element for this document. 197 * @returns {CKEDITOR.dom.element} The DOM document element. 198 */ 197 199 getDocumentElement : function() 198 200 { … … 200 202 201 203 return ( 202 /** @ignore */203 204 this.getDocumentElement = function() 204 205 { … … 210 211 * Gets the window object that holds this document. 211 212 * @returns {CKEDITOR.dom.window} The window object. 212 * @example213 213 */ 214 214 getWindow : function() … … 217 217 218 218 return ( 219 /** @ignore */220 219 this.getWindow = function() 221 220 { -
CKEditor/trunk/_source/core/dom/domobject.js
r4858 r4904 182 182 }; 183 183 184 /** 185 * @name CKEDITOR.dom.domObject.prototype.removeCustomData 186 */ 184 187 domObjectProto.removeCustomData = function( key ) 185 188 { … … 194 197 }; 195 198 199 /** 200 * @name CKEDITOR.dom.domObject.prototype.getCustomData 201 */ 196 202 domObjectProto.getUniqueId = function() 197 203 { -
CKEditor/trunk/_source/core/dom/element.js
r4858 r4904 619 619 620 620 return ( 621 /** @ignore */622 621 this.getName = function() 623 622 { -
CKEditor/trunk/_source/core/dom/node.js
r4858 r4904 233 233 234 234 return ( 235 /** @ignore */236 235 this.getDocument = function() 237 236 { -
CKEditor/trunk/_source/plugins/domiterator/plugin.js
r4858 r4904 12 12 (function() 13 13 { 14 14 /** 15 * @name CKEDITOR.dom.iterator 16 */ 15 17 function iterator( range ) 16 18 {
Note: See TracChangeset
for help on using the changeset viewer.
