f1a1f2607d
## What changes were proposed in this pull request? This PR proposes three things as below: - Support LaTex inline-formula, `\( ... \)` in Scala API documentation It seems currently, ``` \( ... \) ``` are rendered as they are, for example, <img width="345" alt="2017-01-30 10 01 13" src="https://cloud.githubusercontent.com/assets/6477701/22423960/ab37d54a-e737-11e6-9196-4f6229c0189c.png"> It seems mistakenly more backslashes were added. - Fix warnings Scaladoc/Javadoc generation This PR fixes t two types of warnings as below: ``` [warn] .../spark/sql/catalyst/src/main/scala/org/apache/spark/sql/Row.scala:335: Could not find any member to link for "UnsupportedOperationException". [warn] /** [warn] ^ ``` ``` [warn] .../spark/sql/core/src/main/scala/org/apache/spark/sql/internal/VariableSubstitution.scala:24: Variable var undefined in comment for class VariableSubstitution in class VariableSubstitution [warn] * `${var}`, `${system:var}` and `${env:var}`. [warn] ^ ``` - Fix Javadoc8 break ``` [error] .../spark/mllib/target/java/org/apache/spark/ml/PredictionModel.java:7: error: reference not found [error] * E.g., {link VectorUDT} for vector features. [error] ^ [error] .../spark/mllib/target/java/org/apache/spark/ml/PredictorParams.java:12: error: reference not found [error] * E.g., {link VectorUDT} for vector features. [error] ^ [error] .../spark/mllib/target/java/org/apache/spark/ml/Predictor.java:10: error: reference not found [error] * E.g., {link VectorUDT} for vector features. [error] ^ [error] .../spark/sql/hive/target/java/org/apache/spark/sql/hive/HiveAnalysis.java:5: error: reference not found [error] * Note that, this rule must be run after {link PreprocessTableInsertion}. [error] ^ ``` ## How was this patch tested? Manually via `sbt unidoc` and `jeykil build`. Author: hyukjinkwon <gurwls223@gmail.com> Closes #16741 from HyukjinKwon/warn-and-break.
64 lines
2.6 KiB
JavaScript
64 lines
2.6 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() {
|
|
var annotations = $("dt:contains('Annotations')").next("dd").children("span.name");
|
|
addBadges(annotations, "AlphaComponent", ":: AlphaComponent ::", '<span class="alphaComponent badge">Alpha Component</span>');
|
|
addBadges(annotations, "DeveloperApi", ":: DeveloperApi ::", '<span class="developer badge">Developer API</span>');
|
|
addBadges(annotations, "Experimental", ":: Experimental ::", '<span class="experimental badge">Experimental</span>');
|
|
});
|
|
|
|
function addBadges(allAnnotations, name, tag, html) {
|
|
var annotations = allAnnotations.filter(":contains('" + name + "')")
|
|
var tags = $(".cmt:contains(" + tag + ")")
|
|
|
|
// Remove identifier tags from comments
|
|
tags.each(function(index) {
|
|
var oldHTML = $(this).html();
|
|
var newHTML = oldHTML.replace(tag, "");
|
|
$(this).html(newHTML);
|
|
});
|
|
|
|
// Add badges to all containers
|
|
tags.prevAll("h4.signature")
|
|
.add(annotations.closest("div.fullcommenttop"))
|
|
.add(annotations.closest("div.fullcomment").prevAll("h4.signature"))
|
|
.prepend(html);
|
|
}
|
|
|
|
$(document).ready(function() {
|
|
var script = document.createElement('script');
|
|
script.type = 'text/javascript';
|
|
script.async = true;
|
|
script.onload = function(){
|
|
MathJax.Hub.Config({
|
|
displayAlign: "left",
|
|
tex2jax: {
|
|
inlineMath: [ ["$", "$"], ["\\(","\\)"] ],
|
|
displayMath: [ ["$$","$$"], ["\\[", "\\]"] ],
|
|
processEscapes: true,
|
|
skipTags: ['script', 'noscript', 'style', 'textarea', 'pre', 'a']
|
|
}
|
|
});
|
|
};
|
|
script.src = ('https:' == document.location.protocol ? 'https://' : 'http://') +
|
|
'cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML';
|
|
document.getElementsByTagName('head')[0].appendChild(script);
|
|
});
|