From 1505b90a9eb5563a32f8ce761f47c1fa47eb4bcf Mon Sep 17 00:00:00 2001 From: Stefan Kieleithner Date: Fri, 9 Mar 2018 15:21:08 +0100 Subject: [PATCH 1/6] Add parsed unavailable/deprecated attributes to declaration Add new attributes to Mustache item Autolink deprecation and unavailable messages --- lib/jazzy/doc_builder.rb | 3 +++ lib/jazzy/source_declaration.rb | 4 ++++ lib/jazzy/sourcekitten.rb | 7 +++++++ 3 files changed, 14 insertions(+) diff --git a/lib/jazzy/doc_builder.rb b/lib/jazzy/doc_builder.rb index 2a97a3ec0..8d7000692 100644 --- a/lib/jazzy/doc_builder.rb +++ b/lib/jazzy/doc_builder.rb @@ -350,6 +350,9 @@ def self.render_item(item, source_module) start_line: item.start_line, end_line: item.end_line, direct_link: item.omit_content_from_parent?, + deprecation_message: (item.deprecation_message if item.deprecated), + unavailable_message: (item.unavailable_message if item.unavailable), + usage_discouraged: item.deprecated || item.unavailable, } end diff --git a/lib/jazzy/source_declaration.rb b/lib/jazzy/source_declaration.rb index cab107940..e485b3c4c 100644 --- a/lib/jazzy/source_declaration.rb +++ b/lib/jazzy/source_declaration.rb @@ -102,6 +102,10 @@ def display_other_language_declaration attr_accessor :end_line attr_accessor :nav_order attr_accessor :url_name + attr_accessor :deprecated + attr_accessor :deprecation_message + attr_accessor :unavailable + attr_accessor :unavailable_message def alternative_abstract if file = alternative_abstract_file diff --git a/lib/jazzy/sourcekitten.rb b/lib/jazzy/sourcekitten.rb index 046cfae43..5b7f7eef0 100644 --- a/lib/jazzy/sourcekitten.rb +++ b/lib/jazzy/sourcekitten.rb @@ -332,6 +332,9 @@ def self.make_doc_info(doc, declaration) declaration.return = Markdown.rendered_returns declaration.parameters = parameters(doc, Markdown.rendered_parameters) + declaration.deprecation_message = Markdown.render(doc['key.deprecation_message'] || '', Highlighter.default_language) + declaration.unavailable_message = Markdown.render(doc['key.unavailable_message'] || '', Highlighter.default_language) + @stats.add_documented end @@ -482,6 +485,8 @@ def self.make_source_declarations(docs, parent = nil, mark = SourceMark.new) declaration.column = doc['key.doc.column'] declaration.start_line = doc['key.parsed_scope.start'] declaration.end_line = doc['key.parsed_scope.end'] + declaration.deprecated = doc['key.always_deprecated'] + declaration.unavailable = doc['key.always_unavailable'] next unless make_doc_info(doc, declaration) make_substructure(doc, declaration) @@ -749,6 +754,8 @@ def self.autolink(docs, root_decls) doc.return = autolink_text(doc.return, doc, root_decls) if doc.return doc.abstract = autolink_text(doc.abstract, doc, root_decls) + doc.unavailable_message = autolink_text(doc.unavailable_message, doc, root_decls) if doc.unavailable_message + doc.deprecation_message = autolink_text(doc.deprecation_message, doc, root_decls) if doc.deprecation_message (doc.parameters || []).each do |param| param[:discussion] = autolink_text(param[:discussion], doc, root_decls) From 1f1cace891108d3754e6668059ac1ab91c7b3def Mon Sep 17 00:00:00 2001 From: Stefan Kieleithner Date: Fri, 9 Mar 2018 15:24:18 +0100 Subject: [PATCH 2/6] Honor deprecated or unavailable API in all themes --- lib/jazzy/themes/apple/templates/task.mustache | 17 +++++++++++++++++ .../themes/fullwidth/templates/task.mustache | 17 +++++++++++++++++ lib/jazzy/themes/jony/templates/task.mustache | 17 +++++++++++++++++ 3 files changed, 51 insertions(+) diff --git a/lib/jazzy/themes/apple/templates/task.mustache b/lib/jazzy/themes/apple/templates/task.mustache index 7c5b28382..83919d28c 100644 --- a/lib/jazzy/themes/apple/templates/task.mustache +++ b/lib/jazzy/themes/apple/templates/task.mustache @@ -20,7 +20,12 @@ {{/direct_link}} {{^direct_link}} + {{^usage_discouraged}} {{name}} + {{/usage_discouraged}} + {{#usage_discouraged}} + {{name}} + {{/usage_discouraged}} {{#default_impl_abstract}} @@ -37,6 +42,18 @@
+ {{#deprecation_message}} +
+

Deprecated

+ {{{deprecation_message}}} +
+ {{/deprecation_message}} + {{#unavailable_message}} +
+

Unavailable

+ {{{unavailable_message}}} +
+ {{/unavailable_message}} {{#abstract}}
{{{abstract}}} diff --git a/lib/jazzy/themes/fullwidth/templates/task.mustache b/lib/jazzy/themes/fullwidth/templates/task.mustache index 0809a97a0..425876bbf 100644 --- a/lib/jazzy/themes/fullwidth/templates/task.mustache +++ b/lib/jazzy/themes/fullwidth/templates/task.mustache @@ -20,7 +20,12 @@ {{/direct_link}} {{^direct_link}} + {{^usage_discouraged}} {{name}} + {{/usage_discouraged}} + {{#usage_discouraged}} + {{name}} + {{/usage_discouraged}} {{#default_impl_abstract}} @@ -37,6 +42,18 @@
+ {{#deprecation_message}} +
+

Deprecated

+ {{{deprecation_message}}} +
+ {{/deprecation_message}} + {{#unavailable_message}} +
+

Unavailable

+ {{{unavailable_message}}} +
+ {{/unavailable_message}} {{#abstract}}
{{{abstract}}} diff --git a/lib/jazzy/themes/jony/templates/task.mustache b/lib/jazzy/themes/jony/templates/task.mustache index 7c5b28382..83919d28c 100644 --- a/lib/jazzy/themes/jony/templates/task.mustache +++ b/lib/jazzy/themes/jony/templates/task.mustache @@ -20,7 +20,12 @@ {{/direct_link}} {{^direct_link}} + {{^usage_discouraged}} {{name}} + {{/usage_discouraged}} + {{#usage_discouraged}} + {{name}} + {{/usage_discouraged}} {{#default_impl_abstract}} @@ -37,6 +42,18 @@
+ {{#deprecation_message}} +
+

Deprecated

+ {{{deprecation_message}}} +
+ {{/deprecation_message}} + {{#unavailable_message}} +
+

Unavailable

+ {{{unavailable_message}}} +
+ {{/unavailable_message}} {{#abstract}}
{{{abstract}}} From 69f8b27bbaac2ed8fd2859ee0dff099693a8bf6a Mon Sep 17 00:00:00 2001 From: John Fairhurst Date: Sun, 20 Jan 2019 10:36:47 +0000 Subject: [PATCH 3/6] Add unique style and color to deprecated callouts --- lib/jazzy/themes/apple/assets/css/jazzy.css.scss | 2 +- lib/jazzy/themes/apple/templates/task.mustache | 4 ++-- lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss | 2 +- lib/jazzy/themes/fullwidth/templates/task.mustache | 4 ++-- lib/jazzy/themes/jony/assets/css/jazzy.css.scss | 2 +- lib/jazzy/themes/jony/templates/task.mustache | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/jazzy/themes/apple/assets/css/jazzy.css.scss b/lib/jazzy/themes/apple/assets/css/jazzy.css.scss index d37e12a1d..f23d5587d 100644 --- a/lib/jazzy/themes/apple/assets/css/jazzy.css.scss +++ b/lib/jazzy/themes/apple/assets/css/jazzy.css.scss @@ -412,7 +412,7 @@ header { } } -.aside-warning { +.aside-warning, .aside-deprecated, .aside-unavailable { border-left: $aside_warning_border; .aside-title { color: $aside_warning_color; diff --git a/lib/jazzy/themes/apple/templates/task.mustache b/lib/jazzy/themes/apple/templates/task.mustache index 83919d28c..2bbec8d97 100644 --- a/lib/jazzy/themes/apple/templates/task.mustache +++ b/lib/jazzy/themes/apple/templates/task.mustache @@ -43,13 +43,13 @@
{{#deprecation_message}} -
+

Deprecated

{{{deprecation_message}}}
{{/deprecation_message}} {{#unavailable_message}} -
+

Unavailable

{{{unavailable_message}}}
diff --git a/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss b/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss index b8a4aa850..2a156d14a 100644 --- a/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss +++ b/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss @@ -479,7 +479,7 @@ pre code { } } -.aside-warning { +.aside-warning, .aside-deprecated, .aside-unavailable { border-left: $aside_warning_border; .aside-title { color: $aside_warning_color; diff --git a/lib/jazzy/themes/fullwidth/templates/task.mustache b/lib/jazzy/themes/fullwidth/templates/task.mustache index 425876bbf..4bf48f8e0 100644 --- a/lib/jazzy/themes/fullwidth/templates/task.mustache +++ b/lib/jazzy/themes/fullwidth/templates/task.mustache @@ -43,13 +43,13 @@
{{#deprecation_message}} -
+

Deprecated

{{{deprecation_message}}}
{{/deprecation_message}} {{#unavailable_message}} -
+

Unavailable

{{{unavailable_message}}}
diff --git a/lib/jazzy/themes/jony/assets/css/jazzy.css.scss b/lib/jazzy/themes/jony/assets/css/jazzy.css.scss index 2b8a322d8..8e50c99b3 100644 --- a/lib/jazzy/themes/jony/assets/css/jazzy.css.scss +++ b/lib/jazzy/themes/jony/assets/css/jazzy.css.scss @@ -448,7 +448,7 @@ header { } } -.aside-warning { +.aside-warning, .aside-deprecated, .aside-unavailable { border-left: $aside_warning_border; .aside-title { color: $aside_warning_color; diff --git a/lib/jazzy/themes/jony/templates/task.mustache b/lib/jazzy/themes/jony/templates/task.mustache index 83919d28c..2bbec8d97 100644 --- a/lib/jazzy/themes/jony/templates/task.mustache +++ b/lib/jazzy/themes/jony/templates/task.mustache @@ -43,13 +43,13 @@
{{#deprecation_message}} -
+

Deprecated

{{{deprecation_message}}}
{{/deprecation_message}} {{#unavailable_message}} -
+

Unavailable

{{{unavailable_message}}}
From 3ec52de379068b7221ef347ba758ce43ce4ed38f Mon Sep 17 00:00:00 2001 From: John Fairhurst Date: Sun, 20 Jan 2019 10:43:31 +0000 Subject: [PATCH 4/6] Move strikethrough to css --- lib/jazzy/themes/apple/assets/css/jazzy.css.scss | 3 +++ lib/jazzy/themes/apple/templates/task.mustache | 2 +- lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss | 8 +++++++- lib/jazzy/themes/fullwidth/templates/task.mustache | 2 +- lib/jazzy/themes/jony/assets/css/jazzy.css.scss | 3 +++ lib/jazzy/themes/jony/templates/task.mustache | 2 +- 6 files changed, 16 insertions(+), 4 deletions(-) diff --git a/lib/jazzy/themes/apple/assets/css/jazzy.css.scss b/lib/jazzy/themes/apple/assets/css/jazzy.css.scss index f23d5587d..6112fe71a 100644 --- a/lib/jazzy/themes/apple/assets/css/jazzy.css.scss +++ b/lib/jazzy/themes/apple/assets/css/jazzy.css.scss @@ -338,6 +338,9 @@ header { margin-left: 15px; font-size: 11.9px; } + .discouraged { + text-decoration: line-through; + } .declaration-note { font-size: .85em; color: rgba(128,128,128,1); diff --git a/lib/jazzy/themes/apple/templates/task.mustache b/lib/jazzy/themes/apple/templates/task.mustache index 2bbec8d97..ad1b3fb26 100644 --- a/lib/jazzy/themes/apple/templates/task.mustache +++ b/lib/jazzy/themes/apple/templates/task.mustache @@ -24,7 +24,7 @@ {{name}} {{/usage_discouraged}} {{#usage_discouraged}} - {{name}} + {{name}} {{/usage_discouraged}} {{#default_impl_abstract}} diff --git a/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss b/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss index 2a156d14a..575bbb4fa 100644 --- a/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss +++ b/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss @@ -154,8 +154,14 @@ a { outline: 0; text-decoration: underline; } -} + &.discouraged { + text-decoration: line-through; + &:hover, &:focus { + text-decoration: underline line-through; + } + } +} // ----- Tables diff --git a/lib/jazzy/themes/fullwidth/templates/task.mustache b/lib/jazzy/themes/fullwidth/templates/task.mustache index 4bf48f8e0..d06a39bf1 100644 --- a/lib/jazzy/themes/fullwidth/templates/task.mustache +++ b/lib/jazzy/themes/fullwidth/templates/task.mustache @@ -24,7 +24,7 @@ {{name}} {{/usage_discouraged}} {{#usage_discouraged}} - {{name}} + {{name}} {{/usage_discouraged}} {{#default_impl_abstract}} diff --git a/lib/jazzy/themes/jony/assets/css/jazzy.css.scss b/lib/jazzy/themes/jony/assets/css/jazzy.css.scss index 8e50c99b3..5deda2de6 100644 --- a/lib/jazzy/themes/jony/assets/css/jazzy.css.scss +++ b/lib/jazzy/themes/jony/assets/css/jazzy.css.scss @@ -376,6 +376,9 @@ header { padding-left: 3px; margin-left: 35px; } + .discouraged { + text-decoration: line-through; + } .declaration-note { font-size: .85em; color: rgba(128,128,128,1); diff --git a/lib/jazzy/themes/jony/templates/task.mustache b/lib/jazzy/themes/jony/templates/task.mustache index 2bbec8d97..ad1b3fb26 100644 --- a/lib/jazzy/themes/jony/templates/task.mustache +++ b/lib/jazzy/themes/jony/templates/task.mustache @@ -24,7 +24,7 @@ {{name}} {{/usage_discouraged}} {{#usage_discouraged}} - {{name}} + {{name}} {{/usage_discouraged}} {{#default_impl_abstract}} From a8217b8d9f7f24cf5b24f4359a51226e8880a3f4 Mon Sep 17 00:00:00 2001 From: John Fairhurst Date: Sun, 20 Jan 2019 20:37:08 +0000 Subject: [PATCH 5/6] Refactors for rubocop --- lib/jazzy/doc_builder.rb | 8 ++++-- lib/jazzy/source_declaration.rb | 4 +++ lib/jazzy/sourcekitten.rb | 50 +++++++++++++++++++++------------ 3 files changed, 41 insertions(+), 21 deletions(-) diff --git a/lib/jazzy/doc_builder.rb b/lib/jazzy/doc_builder.rb index 8d7000692..00de11009 100644 --- a/lib/jazzy/doc_builder.rb +++ b/lib/jazzy/doc_builder.rb @@ -331,6 +331,7 @@ def self.gh_token_url(item, source_module) # Build mustache item for a top-level doc # @param [Hash] item Parsed doc child item # @param [Config] options Build options + # rubocop:disable Metrics/MethodLength def self.render_item(item, source_module) # Combine abstract and discussion into abstract abstract = (item.abstract || '') + (item.discussion || '') @@ -350,11 +351,12 @@ def self.render_item(item, source_module) start_line: item.start_line, end_line: item.end_line, direct_link: item.omit_content_from_parent?, - deprecation_message: (item.deprecation_message if item.deprecated), - unavailable_message: (item.unavailable_message if item.unavailable), - usage_discouraged: item.deprecated || item.unavailable, + deprecation_message: item.deprecation_message, + unavailable_message: item.unavailable_message, + usage_discouraged: item.usage_discouraged?, } end + # rubocop:enable Metrics/MethodLength def self.make_task(mark, uid, items) { diff --git a/lib/jazzy/source_declaration.rb b/lib/jazzy/source_declaration.rb index e485b3c4c..1be8d0aa8 100644 --- a/lib/jazzy/source_declaration.rb +++ b/lib/jazzy/source_declaration.rb @@ -107,6 +107,10 @@ def display_other_language_declaration attr_accessor :unavailable attr_accessor :unavailable_message + def usage_discouraged? + unavailable || deprecated + end + def alternative_abstract if file = alternative_abstract_file Pathname(file).read diff --git a/lib/jazzy/sourcekitten.rb b/lib/jazzy/sourcekitten.rb index 5b7f7eef0..0fd98a389 100644 --- a/lib/jazzy/sourcekitten.rb +++ b/lib/jazzy/sourcekitten.rb @@ -322,6 +322,8 @@ def self.make_doc_info(doc, declaration) Highlighter.highlight(make_swift_declaration(doc, declaration)) end + make_deprecation_info(doc, declaration) + unless doc['key.doc.full_as_xml'] return process_undocumented_token(doc, declaration) end @@ -332,12 +334,20 @@ def self.make_doc_info(doc, declaration) declaration.return = Markdown.rendered_returns declaration.parameters = parameters(doc, Markdown.rendered_parameters) - declaration.deprecation_message = Markdown.render(doc['key.deprecation_message'] || '', Highlighter.default_language) - declaration.unavailable_message = Markdown.render(doc['key.unavailable_message'] || '', Highlighter.default_language) - @stats.add_documented end + def self.make_deprecation_info(doc, declaration) + if declaration.deprecated + declaration.deprecation_message = + Markdown.render(doc['key.deprecation_message'] || '') + end + if declaration.unavailable + declaration.unavailable_message = + Markdown.render(doc['key.unavailable_message'] || '') + end + end + # Strip tags and convert entities def self.xml_to_text(xml) document = REXML::Document.new(xml) @@ -747,30 +757,34 @@ def self.autolink_text(text, doc, root_decls, after_highlight = false) end end + AUTOLINK_TEXT_FIELDS = %w[return + abstract + unavailable_message + deprecation_message].freeze + + AUTOLINK_HIGHLIGHT_FIELDS = %w[declaration + other_language_declaration].freeze + def self.autolink(docs, root_decls) @autolink_root_decls = root_decls docs.each do |doc| doc.children = autolink(doc.children, root_decls) - doc.return = autolink_text(doc.return, doc, root_decls) if doc.return - doc.abstract = autolink_text(doc.abstract, doc, root_decls) - doc.unavailable_message = autolink_text(doc.unavailable_message, doc, root_decls) if doc.unavailable_message - doc.deprecation_message = autolink_text(doc.deprecation_message, doc, root_decls) if doc.deprecation_message - (doc.parameters || []).each do |param| - param[:discussion] = - autolink_text(param[:discussion], doc, root_decls) + AUTOLINK_TEXT_FIELDS.each do |field| + if text = doc.send(field) + doc.send(field + '=', autolink_text(text, doc, root_decls)) + end end - if doc.declaration - doc.declaration = autolink_text( - doc.declaration, doc, root_decls, true - ) + AUTOLINK_HIGHLIGHT_FIELDS.each do |field| + if text = doc.send(field) + doc.send(field + '=', autolink_text(text, doc, root_decls, true)) + end end - if doc.other_language_declaration - doc.other_language_declaration = autolink_text( - doc.other_language_declaration, doc, root_decls, true - ) + (doc.parameters || []).each do |param| + param[:discussion] = + autolink_text(param[:discussion], doc, root_decls) end end end From a231e9d5e99be63aa40a7251bfa88a5feda165e6 Mon Sep 17 00:00:00 2001 From: John Fairhurst Date: Mon, 21 Jan 2019 18:16:04 +0000 Subject: [PATCH 6/6] Add deprecation notice to types And add some more testcases. --- CHANGELOG.md | 5 +++++ lib/jazzy/doc_builder.rb | 3 +++ .../themes/apple/templates/deprecation.mustache | 12 ++++++++++++ lib/jazzy/themes/apple/templates/doc.mustache | 1 + lib/jazzy/themes/apple/templates/task.mustache | 13 +------------ .../themes/fullwidth/templates/deprecation.mustache | 12 ++++++++++++ lib/jazzy/themes/fullwidth/templates/doc.mustache | 1 + lib/jazzy/themes/fullwidth/templates/task.mustache | 13 +------------ .../themes/jony/templates/deprecation.mustache | 12 ++++++++++++ lib/jazzy/themes/jony/templates/doc.mustache | 1 + lib/jazzy/themes/jony/templates/task.mustache | 13 +------------ spec/integration_specs | 2 +- 12 files changed, 51 insertions(+), 37 deletions(-) create mode 100644 lib/jazzy/themes/apple/templates/deprecation.mustache create mode 100644 lib/jazzy/themes/fullwidth/templates/deprecation.mustache create mode 100644 lib/jazzy/themes/jony/templates/deprecation.mustache diff --git a/CHANGELOG.md b/CHANGELOG.md index e314ac87d..711ae4bb3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,11 @@ [John Fairhurst](https://github.com/johnfairh) [#730](https://github.com/realm/jazzy/issues/730) +* Call out unavailable and deprecated Objective-C declarations. + [Stefan Kieleithner](https://github.com/steviki) + [John Fairhurst](https://github.com/johnfairh) + [#843](https://github.com/realm/jazzy/issues/843) + ##### Bug Fixes * Support Swift 4.2 with `--podspec`. diff --git a/lib/jazzy/doc_builder.rb b/lib/jazzy/doc_builder.rb index 00de11009..ebc2ebc5b 100644 --- a/lib/jazzy/doc_builder.rb +++ b/lib/jazzy/doc_builder.rb @@ -423,6 +423,9 @@ def self.document(source_module, doc_model, path_to_root) doc[:github_url] = source_module.github_url doc[:dash_url] = source_module.dash_url doc[:path_to_root] = path_to_root + doc[:deprecation_message] = doc_model.deprecation_message + doc[:unavailable_message] = doc_model.unavailable_message + doc[:usage_discouraged] = doc_model.usage_discouraged? doc.render.gsub(ELIDED_AUTOLINK_TOKEN, path_to_root) end # rubocop:enable Metrics/MethodLength diff --git a/lib/jazzy/themes/apple/templates/deprecation.mustache b/lib/jazzy/themes/apple/templates/deprecation.mustache new file mode 100644 index 000000000..cfcabac31 --- /dev/null +++ b/lib/jazzy/themes/apple/templates/deprecation.mustache @@ -0,0 +1,12 @@ +{{#deprecation_message}} +
+

Deprecated

+ {{{deprecation_message}}} +
+{{/deprecation_message}} +{{#unavailable_message}} +
+

Unavailable

+ {{{unavailable_message}}} +
+{{/unavailable_message}} diff --git a/lib/jazzy/themes/apple/templates/doc.mustache b/lib/jazzy/themes/apple/templates/doc.mustache index 140b59cf8..cfbea3ac9 100644 --- a/lib/jazzy/themes/apple/templates/doc.mustache +++ b/lib/jazzy/themes/apple/templates/doc.mustache @@ -28,6 +28,7 @@
{{^hide_name}}

{{name}}

{{/hide_name}} + {{> deprecation}} {{#declaration}}
diff --git a/lib/jazzy/themes/apple/templates/task.mustache b/lib/jazzy/themes/apple/templates/task.mustache index ad1b3fb26..e1cc4c1c6 100644 --- a/lib/jazzy/themes/apple/templates/task.mustache +++ b/lib/jazzy/themes/apple/templates/task.mustache @@ -42,18 +42,7 @@
- {{#deprecation_message}} -
-

Deprecated

- {{{deprecation_message}}} -
- {{/deprecation_message}} - {{#unavailable_message}} -
-

Unavailable

- {{{unavailable_message}}} -
- {{/unavailable_message}} + {{> deprecation}} {{#abstract}}
{{{abstract}}} diff --git a/lib/jazzy/themes/fullwidth/templates/deprecation.mustache b/lib/jazzy/themes/fullwidth/templates/deprecation.mustache new file mode 100644 index 000000000..cfcabac31 --- /dev/null +++ b/lib/jazzy/themes/fullwidth/templates/deprecation.mustache @@ -0,0 +1,12 @@ +{{#deprecation_message}} +
+

Deprecated

+ {{{deprecation_message}}} +
+{{/deprecation_message}} +{{#unavailable_message}} +
+

Unavailable

+ {{{unavailable_message}}} +
+{{/unavailable_message}} diff --git a/lib/jazzy/themes/fullwidth/templates/doc.mustache b/lib/jazzy/themes/fullwidth/templates/doc.mustache index 6af90fbaf..1ee3ad86b 100644 --- a/lib/jazzy/themes/fullwidth/templates/doc.mustache +++ b/lib/jazzy/themes/fullwidth/templates/doc.mustache @@ -37,6 +37,7 @@
{{^hide_name}}

{{name}}

{{/hide_name}} + {{> deprecation}} {{#declaration}}
diff --git a/lib/jazzy/themes/fullwidth/templates/task.mustache b/lib/jazzy/themes/fullwidth/templates/task.mustache index d06a39bf1..65f1bacd0 100644 --- a/lib/jazzy/themes/fullwidth/templates/task.mustache +++ b/lib/jazzy/themes/fullwidth/templates/task.mustache @@ -42,18 +42,7 @@
- {{#deprecation_message}} -
-

Deprecated

- {{{deprecation_message}}} -
- {{/deprecation_message}} - {{#unavailable_message}} -
-

Unavailable

- {{{unavailable_message}}} -
- {{/unavailable_message}} + {{> deprecation}} {{#abstract}}
{{{abstract}}} diff --git a/lib/jazzy/themes/jony/templates/deprecation.mustache b/lib/jazzy/themes/jony/templates/deprecation.mustache new file mode 100644 index 000000000..cfcabac31 --- /dev/null +++ b/lib/jazzy/themes/jony/templates/deprecation.mustache @@ -0,0 +1,12 @@ +{{#deprecation_message}} +
+

Deprecated

+ {{{deprecation_message}}} +
+{{/deprecation_message}} +{{#unavailable_message}} +
+

Unavailable

+ {{{unavailable_message}}} +
+{{/unavailable_message}} diff --git a/lib/jazzy/themes/jony/templates/doc.mustache b/lib/jazzy/themes/jony/templates/doc.mustache index 7c4a8a9fc..9874fb403 100644 --- a/lib/jazzy/themes/jony/templates/doc.mustache +++ b/lib/jazzy/themes/jony/templates/doc.mustache @@ -33,6 +33,7 @@
{{^hide_name}}

{{name}}

{{/hide_name}} + {{> deprecation}} {{#declaration}}
diff --git a/lib/jazzy/themes/jony/templates/task.mustache b/lib/jazzy/themes/jony/templates/task.mustache index ad1b3fb26..e1cc4c1c6 100644 --- a/lib/jazzy/themes/jony/templates/task.mustache +++ b/lib/jazzy/themes/jony/templates/task.mustache @@ -42,18 +42,7 @@
- {{#deprecation_message}} -
-

Deprecated

- {{{deprecation_message}}} -
- {{/deprecation_message}} - {{#unavailable_message}} -
-

Unavailable

- {{{unavailable_message}}} -
- {{/unavailable_message}} + {{> deprecation}} {{#abstract}}
{{{abstract}}} diff --git a/spec/integration_specs b/spec/integration_specs index 9d74e17e2..09ff8df58 160000 --- a/spec/integration_specs +++ b/spec/integration_specs @@ -1 +1 @@ -Subproject commit 9d74e17e2fd6e72770a62b3198169bab518993f2 +Subproject commit 09ff8df580853fa22e1535cd7c88b69a63126d55