[GitHub] spark pull request #16741: [WIP][SPARK-19402][DOCS] Support LaTex inline ann...

[HyukjinKwon]

GitHub user HyukjinKwon opened a pull request:

    https://github.com/apache/spark/pull/16741

    [WIP][SPARK-19402][DOCS] Support LaTex inline annotation correctly and fix 
warnings in Scala/Java APIs generation

    ## What changes were proposed in this pull request?
    
    This PR proposes three things as below:
    
    - Support inline-expression, `\( ... \)` 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 three 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]      ^
      ```
    
      ```
      [warn] 
.../spark/core/src/main/scala/org/apache/spark/scheduler/package.scala:20: 
Could not find any member to link for "org.apache.spark.scheduler.DAGScheduler".
      [warn]   /**
      [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`.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/HyukjinKwon/spark warn-and-break

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/spark/pull/16741.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #16741
    
----
commit 0880b9b1c3488f57e54b689b72b5aafdab18d02f
Author: hyukjinkwon <gurwls...@gmail.com>
Date:   2017-01-30T10:54:01Z

    Fix warnings and javadoc8 break

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org