diff options
author | Deron Eriksson <deron@us.ibm.com> | 2015-07-02 13:55:53 -0700 |
---|---|---|
committer | Andrew Or <andrew@databricks.com> | 2015-07-02 13:55:53 -0700 |
commit | fcbcba66c92871fe3936e5ca605017e9c2a2eb95 (patch) | |
tree | c9d80d11774826d6bd6e30d039e27831c3ca21e3 /docs/js/api-javadocs.js | |
parent | 82cf3315e690f4ac15b50edea6a3d673aa5be4c0 (diff) | |
download | spark-fcbcba66c92871fe3936e5ca605017e9c2a2eb95.tar.gz spark-fcbcba66c92871fe3936e5ca605017e9c2a2eb95.tar.bz2 spark-fcbcba66c92871fe3936e5ca605017e9c2a2eb95.zip |
[SPARK-1564] [DOCS] Added Javascript to Javadocs to create badges for tags like :: Experimental ::
Modified copy_api_dirs.rb and created api-javadocs.js and api-javadocs.css files in order to add badges to javadoc files for :: Experimental ::, :: DeveloperApi ::, and :: AlphaComponent :: tags
Author: Deron Eriksson <deron@us.ibm.com>
Closes #7169 from deroneriksson/SPARK-1564_JavaDocs_badges and squashes the following commits:
a8353db [Deron Eriksson] added license headers to api-docs.css and api-javadocs.css
07feb07 [Deron Eriksson] added linebreaks to make jquery more readable when adding html badge tags
65b4930 [Deron Eriksson] Modified copy_api_dirs.rb and created api-javadocs.js and api-javadocs.css files in order to add badges to javadoc files for :: Experimental ::, :: DeveloperApi ::, and :: AlphaComponent :: tags
Diffstat (limited to 'docs/js/api-javadocs.js')
-rw-r--r-- | docs/js/api-javadocs.js | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/js/api-javadocs.js b/docs/js/api-javadocs.js new file mode 100644 index 0000000000..ead13d6e5f --- /dev/null +++ b/docs/js/api-javadocs.js @@ -0,0 +1,60 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/* Dynamically injected post-processing code for the API docs */ + +$(document).ready(function() { + addBadges(":: AlphaComponent ::", '<span class="alphaComponent badge">Alpha Component</span>'); + addBadges(":: DeveloperApi ::", '<span class="developer badge">Developer API</span>'); + addBadges(":: Experimental ::", '<span class="experimental badge">Experimental</span>'); +}); + +function addBadges(tag, html) { + var tags = $(".block:contains(" + tag + ")") + + // Remove identifier tags + tags.each(function(index) { + var oldHTML = $(this).html(); + var newHTML = oldHTML.replace(tag, ""); + $(this).html(newHTML); + }); + + // Add html badge tags + tags.each(function(index) { + if ($(this).parent().is('td.colLast')) { + $(this).parent().prepend(html); + } else if ($(this).parent('li.blockList') + .parent('ul.blockList') + .parent('div.description') + .parent().is('div.contentContainer')) { + var contentContainer = $(this).parent('li.blockList') + .parent('ul.blockList') + .parent('div.description') + .parent('div.contentContainer') + var header = contentContainer.prev('div.header'); + if (header.length > 0) { + header.prepend(html); + } else { + contentContainer.prepend(html); + } + } else if ($(this).parent().is('li.blockList')) { + $(this).parent().prepend(html); + } else { + $(this).prepend(html); + } + }); +} |