Commit 2bb2665b authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Render default values and required config options. 

Place default value to separate line in cfg/param description.

For required config options, display label (analogus to "static").
parent cc1d2e58

lib/jsduck/exporter.rb

+1 −1
Original line number Diff line number Diff line
@@ -49,7 +49,7 @@ module JsDuck 
      @formatter.doc_context = m

      m[:doc] = @formatter.format(m[:doc]) if m[:doc]

      m[:deprecated][:text] = @formatter.format(m[:deprecated][:text]) if m[:deprecated]

      if m[:params] || (m[:properties] && m[:properties].length > 0) || @formatter.too_long?(m[:doc])

      if m[:params] || (m[:properties] && m[:properties].length > 0) || m[:default] || @formatter.too_long?(m[:doc])

        m[:shortDoc] = @formatter.shorten(m[:doc])

      end

      m[:params] = format_params(m[:params]) if m[:params]

template/app/Renderer.js

+16 −6
Original line number Diff line number Diff line
@@ -212,8 +212,7 @@ Ext.define('Docs.Renderer', { 
        }



        if (member.tagname === "cfg" || member.tagname === "property") {

            var defaultValue = member["default"] ? " (default: " + Ext.htmlEncode(member["default"]) + ")" : "";

            cfg.params = "<span> : " + member.type + defaultValue + "</span>";

            cfg.params = "<span> : " + member.type + "</span>";

        }

        else {

            var ps = Ext.Array.map(member.params, this.renderShortParam, this).join(", ");
@@ -223,14 +222,18 @@ Ext.define('Docs.Renderer', { 
            }

        }



        cfg.after = "";

        if (member['protected']) {

            cfg.after = "<strong class='protected-signature'>protected</strong>";

            cfg.after += "<strong class='protected-signature'>protected</strong>";

        }

        if (member['static']) {

            cfg.after = "<strong class='static-signature'>static</strong>";

            cfg.after += "<strong class='static-signature'>static</strong>";

        }

        if (member.deprecated) {

            cfg.after = "<strong class='deprecated-signature'>deprecated</strong>";

            cfg.after += "<strong class='deprecated-signature'>deprecated</strong>";

        }

        if (member.tagname === "cfg" && !member.optional) {

            cfg.after += "<strong class='required-signature'>required</strong>";

        }



        return this.signatureTpl.apply(cfg);
@@ -244,6 +247,10 @@ Ext.define('Docs.Renderer', { 
    renderLongDoc: function(member) {

        var doc = member.doc;



        if (member["default"]) {

            doc += "<p>Defaults to: <code>" + Ext.String.htmlEncode(member["default"]) + "</code></p>";

        }



        if (member.deprecated) {

            var v = member.deprecated.version ? "since " + member.deprecated.version : "";

            doc += '<div class="deprecated">';
@@ -302,6 +309,9 @@ Ext.define('Docs.Renderer', { 
                '<tpl if="optional"> (optional)</tpl>',

                '<div class="sub-desc">',

                    '{doc}',

                    '<tpl if="values[&quot;default&quot;]">',

                        '<p>Defaults to: <code>{[Ext.String.htmlEncode(values["default"])]}</code></p>',

                    '</tpl>',

                    '<tpl if="properties && properties.length">',

                        '{[this.renderParamsAndReturn(values)]}',

                    '</tpl>',

template/resources/sass/viewport.scss

+3 −1
Original line number Diff line number Diff line
@@ -533,7 +533,7 @@ a { 
    @include guides-h3-heading; } }



.class-overview {

  .deprecated-signature, .protected-signature, .static-signature {

  .deprecated-signature, .protected-signature, .static-signature, .required-signature {

    font-weight: bold;

    text-transform: uppercase;

    color: white;
@@ -547,6 +547,8 @@ a { 
    background-color: #aaa; }

  .static-signature {

    background-color: $docs-text-color; }

  .required-signature {

    background-color: $docs-text-color; }

  .constructor-signature {

    margin-left: 0;

    margin-right: 3px;