Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[MXNET-319] Javadoc fix #11143

Closed
wants to merge 21 commits into from
Closed

Conversation

lanking520
Copy link
Member

@lanking520 lanking520 commented Jun 4, 2018

Description

This is the second proposed solution to this: #11123
Add Java doc support.
@nswamy @yzhliu @andrewfayres
Be aware, I have imported a third party library to generate the Scala doc. Please check the pom file carefully.

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

@lanking520 lanking520 requested a review from yzhliu as a code owner June 4, 2018 23:37
@yzhliu yzhliu changed the title [MXNET-319] Javadoc fix [MXNET-319] Javadoc fix (Approach 2) Jun 5, 2018
@@ -60,8 +62,34 @@ private[mxnet] object APIDocGenerator{
pw.close()
}

def oldAPIClassGen(FILE_PATH : String, isSymbol : Boolean) : Unit = {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just find a better name for 'old' ...

@yzhliu yzhliu changed the title [MXNET-319] Javadoc fix (Approach 2) [MXNET-319] Javadoc fix Jun 5, 2018
@lanking520
Copy link
Member Author

This PR is screwed by the submodule update. Abandon this one and create an identical one here: #11239

@lanking520 lanking520 closed this Jun 12, 2018
@lanking520 lanking520 deleted the javadoc-fix branch June 13, 2018 17:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants