fcbcba66c9
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
61 lines
2.3 KiB
JavaScript
61 lines
2.3 KiB
JavaScript
/*
|
|
* 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);
|
|
}
|
|
});
|
|
}
|