Changeset 4904


Ignore:
Timestamp:
01/08/10 12:19:16 (6 years ago)
Author:
fredck
Message:

Upgraded to JsDoc Toolkit 2.3.2.

Location:
CKEditor/trunk
Files:
12 edited

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-toolkit
         1jsdoc-toolkit http://jsdoc-toolkit.googlecode.com/svn/tags/jsdoc_toolkit-2.3.2/jsdoc-toolkit
  • CKEditor/trunk/_dev/docs_build/docs_build.conf

    r4040 r4904  
    1717                '../../_source/core/',
    1818                '../../_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'
    2126        ],
    2227
  • CKEditor/trunk/_dev/docs_build/template/allfiles.tmpl

    r4901 r4904  
    33<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    44        <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+}" />
    66                {! Link.base = ""; /* all generated links will be relative to this */ !}
    77                <title>File Index - CKEditor 3 JavaScript API Documentation</title>
     
    2626                        <div>
    2727                                <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>
    2929                                <dl>
    3030                                        <if test="item.author">
  • CKEditor/trunk/_dev/docs_build/template/class.tmpl

    r4901 r4904  
    5151<!-- ============================== class summary ========================== -->                       
    5252                        <p class="description">
     53                                <if test="data.version"><br />Version
     54                                        {+ data.version +}.<br />
     55                                </if>
    5356                                <if test="data.augments.length"><br />Extends
    5457                                        {+
     
    210213                                                        !}&nbsp;</td>
    211214                                                        <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)+}
    213216                                                                </div>
    214217                                                                <div class="description">{+resolveLinks(summarize(member.desc))+}</div>
     
    249252                        </if>
    250253
     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 += "&lt;private&gt; ";
     271                                                                if (member.isInner) output += "&lt;inner&gt; ";
     272                                                                if (member.isStatic) output += "&lt;static&gt; ";
     273                                                        !}&nbsp;</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
    251314<!-- ============================== constructor details ==================== -->               
    252315                        <if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))">
     
    398461                                                        <dt class="heading">Deprecated:</dt>
    399462                                                        <dt>
    400                                                                 {+ member.deprecated +}
     463                                                                {+ resolveLinks(member.deprecated) +}
    401464                                                        </dt>
    402465                                                        </dl>
     
    437500                                       
    438501                                        <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)+}
    440503                                       
    441504                                        </div>
     
    484547                                                        <dt class="heading">Deprecated:</dt>
    485548                                                        <dt>
    486                                                                 {+member.deprecated+}
     549                                                                {+resolveLinks(member.deprecated)+}
    487550                                                        </dt>
    488551                                                        </dl>
     
    527590                                </for>
    528591                        </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 += "&lt;private&gt; ";
     602                                                if (member.isInner) output += "&lt;inner&gt; ";
     603                                                if (member.isStatic) output += "&lt;static&gt; ";
     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
    530692                        <hr />
    531693                </div>
  • CKEditor/trunk/_dev/docs_build/template/index.tmpl

    r4901 r4904  
    33<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    44        <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+}" />
    66               
    77                <title>CKEditor 3 JavaScript API Documentation</title>
  • CKEditor/trunk/_dev/docs_build/template/publish.js

    r3260 r4904  
     1/** Called automatically by JsDoc Toolkit. */
    12function publish(symbolSet) {
    23        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/"
    89        };
    910        if (!IO.exists(publish.conf.templatesDir)) {
     
    1112        }
    1213
     14        // is source output is suppressed, just display the links to the source file
    1315        if (JSDOC.opt.s && defined(Link) && Link.prototype._makeSrcLink) {
    1416                Link.prototype._makeSrcLink = function(srcFilePath) {
     
    1719        }
    1820
     21        // create the folders and subfolders to hold the output
    1922        IO.mkPath((publish.conf.outDir+"symbols/src").split("/"));
    2023
    21         // used to check the details of things being linked to
     24        // used to allow Link to check the details of things being linked to
    2225        Link.symbolSet = symbolSet;
    2326
     27        // create the required templates
    2428        try {
    2529                var classTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"class.tmpl");
     
    2731        }
    2832        catch(e) {
    29                 print(e.message);
     33                print("Couldn't create the required templates: "+e);
    3034                quit();
    3135        }
    3236
    33         // filters
     37        // some ustility filters
    3438        function hasNoParent($) {return ($.memberOf == "")}
    3539        function isaFile($) {return ($.is("FILE"))}
    3640        function isaClass($) {return ($.is("CONSTRUCTOR") || $.isNamespace)}
    3741
     42        // get an array version of the symbolset, useful for filtering
    3843        var symbols = symbolSet.toArray();
    3944
     45        // create the hilited source code files
    4046        var files = JSDOC.opt.srcFiles;
    4147        for (var i = 0, l = files.length; i < l; i++) {
     
    4551        }
    4652
     53        // get a list of all the classes in the symbolset
    4754        var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
    4855
     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
    4973        Link.base = "../";
    5074        publish.classesIndex = classesTemplate.process(classes); // kept in memory
    5175
     76        // create each of the class pages
    5277        for (var i = 0, l = classes.length; i < l; i++) {
    5378                var symbol = classes[i];
     79               
     80                symbol.events = symbol.getEvents();   // 1 order matters
     81                symbol.methods = symbol.getMethods(); // 2
     82               
    5483                var output = "";
    5584                output = classTemplate.process(symbol);
    5685
    57                 IO.saveFile(publish.conf.outDir+"symbols/", symbol.alias+publish.conf.ext, output);
    58         }
    59 
    60         // regenrate the index with different relative links
     86                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
    6190        Link.base = "";
    6291        publish.classesIndex = classesTemplate.process(classes);
    6392
     93        // create the class index page
    6494        try {
    6595                var classesindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"index.tmpl");
     
    71101        classesindexTemplate = classesIndex = classes = null;
    72102
     103        // create the file index page
    73104        try {
    74105                var fileindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allfiles.tmpl");
     
    76107        catch(e) { print(e.message); quit(); }
    77108
    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
    80111
    81112        for (var i = 0; i < files.length; i++) {
     
    96127        allFiles = allFiles.sort( ckeditor_sortFiles );
    97128
     129        // output the file index page
    98130        var filesIndex = fileindexTemplate.process(allFiles);
    99131        IO.saveFile(publish.conf.outDir, "files"+publish.conf.ext, filesIndex);
     
    102134
    103135
    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. */
    105137function summarize(desc) {
    106138        if (typeof desc != "undefined")
     
    108140}
    109141
    110 /** make a symbol sorter by some attribute */
     142/** Make a symbol sorter by some attribute. */
    111143function makeSortby(attribute) {
    112144        return function(a, b) {
     
    121153}
    122154
     155/** Pull in the contents of an external file at the given path. */
    123156function include(path) {
    124157        var path = publish.conf.templatesDir+path;
     
    126159}
    127160
     161/** Turn a raw source file into a code-hilited page in the docs. */
    128162function makeSrcFile(path, srcDir, name) {
    129163        if (JSDOC.opt.s) return;
     
    145179}
    146180
     181/** Build output for displaying function parameters. */
    147182function makeSignature(params) {
    148183        if (!params) return "()";
  • CKEditor/trunk/_source/core/ckeditor_basic.js

    r4858 r4904  
    138138                };
    139139
    140                 /**
     140                /*
    141141                 * @ignore
    142142                 * Documented at ckeditor.js.
  • CKEditor/trunk/_source/core/dom/document.js

    r4858 r4904  
    169169
    170170                        return (
    171                         /** @ignore */
    172171                        this.getHead = function()
    173172                                {
     
    188187
    189188                        return (
    190                         /** @ignore */
    191189                        this.getBody = function()
    192190                                {
     
    195193                },
    196194
     195                /**
     196                 * Gets the DOM document element for this document.
     197                 * @returns {CKEDITOR.dom.element} The DOM document element.
     198                 */
    197199                getDocumentElement : function()
    198200                {
     
    200202
    201203                        return (
    202                         /** @ignore */
    203204                        this.getDocumentElement = function()
    204205                                {
     
    210211                 * Gets the window object that holds this document.
    211212                 * @returns {CKEDITOR.dom.window} The window object.
    212                  * @example
    213213                 */
    214214                getWindow : function()
     
    217217
    218218                        return (
    219                         /** @ignore */
    220219                        this.getWindow = function()
    221220                                {
  • CKEditor/trunk/_source/core/dom/domobject.js

    r4858 r4904  
    182182        };
    183183
     184        /**
     185         * @name CKEDITOR.dom.domObject.prototype.removeCustomData
     186         */
    184187        domObjectProto.removeCustomData = function( key )
    185188        {
     
    194197        };
    195198
     199        /**
     200         * @name CKEDITOR.dom.domObject.prototype.getCustomData
     201         */
    196202        domObjectProto.getUniqueId = function()
    197203        {
  • CKEditor/trunk/_source/core/dom/element.js

    r4858 r4904  
    619619
    620620                        return (
    621                         /** @ignore */
    622621                        this.getName = function()
    623622                                {
  • CKEditor/trunk/_source/core/dom/node.js

    r4858 r4904  
    233233
    234234                        return (
    235                         /** @ignore */
    236235                        this.getDocument = function()
    237236                                {
  • CKEditor/trunk/_source/plugins/domiterator/plugin.js

    r4858 r4904  
    1212(function()
    1313{
    14 
     14        /**
     15         * @name CKEDITOR.dom.iterator
     16         */
    1517        function iterator( range )
    1618        {
Note: See TracChangeset for help on using the changeset viewer.
© 2003 – 2015 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy